使用说明
Django SaaS MCP服务器
一个MCP（模型上下文协议）服务器，为Django SaaS开发提供自主协助。该服务器在后台持续运行，监控您的Django项目，并通过VS Code Copilot提供主动帮助，无需手动干预。
特性
- 🔍 连续监控：自动监视Django项目文件的更改
- 🤖 自主协助：提供建议并检测问题，无需用户操作
- 🛠️ Django专用工具：公开Django开发的专用工具
- 📊 项目分析：分析Django项目结构并识别应用程序
- ⚠️ 问题检测：检测常见的Django模式、反模式和安全问题
- 🔄 实时更新：监视模型、视图、设置、模板等
它监控什么
服务器会自动监视：
- Python文件(
**/*.py) - Django核心文件(
settings.py,models.py,views.py,urls.py,manage.py) - 模板(
**/templates/**/*.html) - 需求文件(
requirements*.txt)
并忽略：
- 虚拟环境(
venv/,env/) - Python缓存(
__pycache__/,*.pyc) - 节点模块(
node_modules/) - 构建目录
可用工具
1. set_django_project_path
设置Django项目的监控路径。
输入：
{
"path": "/absolute/path/to/django/project"
}
输出：
{
"success": true,
"message": "Now monitoring Django project at: /path/to/project",
"monitoringActive": true
}
2. analyze_django_project
分析Django项目结构并检测潜在问题。
输出：
{
"projectPath": "/path/to/project",
"hasDjango": true,
"apps": ["blog", "users", "api"],
"hasSettings": true,
"hasManagePy": true,
"issues": [],
"fileCount": 45
}
3. check_django_file
检查特定的Django文件以了解常见问题并获得建议。
输入：
{
"filePath": "myapp/models.py"
}
输出：
{
"filePath": "/absolute/path/to/file",
"exists": true,
"issues": ["Missing Django models import"],
"suggestions": ["Add: from django.db import models"]
}
4. list_monitored_files
列出当前正在监视的所有文件。
输入：
{
"pattern": "models.py" // Optional filter
}
输出：
{
"totalFiles": 3,
"files": [
{
"path": "/full/path/to/file",
"relativePath": "blog/models.py",
"size": 1024,
"lastModified": "2025-10-26T12:00:00.000Z"
}
]
}
安装和设置
先决条件
- 已安装Node.js 18+
- VS代码与GitHub Copilot
- Django项目
设置步骤
-
再进行 （在创建工作空间时已完成）
npm install -
构建服务器 （已完成）
npm run build -
在VS代码中配置 服务器已在中配置
.vscode/mcp.json.VS Code Copilot将在您打开此工作区时自动连接到它。 -
验证连接
- 打开VS代码
- 打开命令选项板(
Ctrl+Shift+P或Cmd+Shift+P) - 键入“MCP”查看MCP相关命令
- 这
django-saas-assistant应列出服务器
用法
使用VS代码副本
配置后，MCP服务器将在后台自动运行。您可以通过Copilot与它进行交互：
-
设置Django项目路径 在Copilot聊天中，问：
@workspace Use the django-saas-assistant to monitor my Django project at /path/to/my/project -
分析您的项目
@workspace Analyze my Django project structure -
检查问题
@workspace Check my Django models file for issues -
列出受监视的文件
@workspace Show me all monitored Django files
自主监控
服务器持续运行并将活动记录到stderr（在MCP输出通道中可见）：
- 文件添加
- 文件修改
- 文件删除
- 检测到的问题
发展
项目结构
.
├── src/
│ └── index.ts # Main server implementation
├── build/ # Compiled JavaScript (generated)
├── .vscode/
│ └── mcp.json # MCP server configuration
├── .github/
│ └── copilot-instructions.md
├── package.json
├── tsconfig.json
└── README.md
建筑
npm run build
观看模式（用于开发）
npm run watch
本地运行
npm run dev
问题检测
服务器会自动检测：
型号(models.py)
- 缺少Django模型导入
- 模型类定义不正确
- 缺少迁移目录
浏览次数(views.py)
- 缺少Django导入
设置(settings.py)
DEBUG = True与空ALLOWED_HOSTS（安全风险）- 硬编码
SECRET_KEY（安全风险）
项目结构
- 没有设置文件
manage.py - 没有应用程序的Django项目
运作原理
- 文件监视：用途
chokidar实时监控Django文件 - 模式检测：分析Django特定模式的文件内容
- MCP协议：通过模型上下文协议公开工具
- 标准运输：通过标准输入/输出与VS Code通信
- 副驾驶集成：与GitHub Copilot无缝协作，实现自主辅助
调试
要查看服务器日志，请执行以下操作：
- 打开VS代码输出面板(
View→Output) - 从下拉列表中选择“MCP:django saas助手”
- 在服务器监视您的项目时查看实时日志
配置
更改项目路径
编辑 .vscode/mcp.json 指向不同的位置：
{
"servers": {
"django-saas-assistant": {
"type": "stdio",
"command": "node",
"args": [
"/your/custom/path/build/index.js"
]
}
}
}
故障排除
服务器未启动
- 确保已安装Node.js：
node --version - 检查构建输出：
npm run build - 验证中的路径
.vscode/mcp.json
没有正在监视的文件
- 使用
set_django_project_path设置正确路径的工具 - 检查路径是否包含Django文件
- 查看MCP输出日志
副驾驶中未显示工具
- 重新启动VS代码
- 在输出面板中检查MCP服务器状态
- 验证
.vscode/mcp.json配置
贡献
这是Django SaaS开发的自主助手。要扩展它：
- 在中添加新工具
src/index.ts使用server.registerTool() - 为其他模式实现新的文件监视器
- 添加更多问题检测逻辑
- 构建和测试：
npm run build
许可证
麻省理工学院
支持
对于问题或疑问：
- 检查MCP服务器登录VS代码输出
- 查看此自述文件
- 检查MCP规格：https://modelcontextprotocol.io/
备注：此服务器设计为在后台连续运行。当您使用此工作区打开VS Code时，它会自动启动，并通过Copilot提供自主协助，而不需要手动命令。
