内容审阅器MCP服务器(VS代码)
旨在通过VS Code运行的最小MCP服务器 .vscode/mcp.json.
它的作用:
- 将配置的Git存储库克隆到本地缓存中
- 将配置的内容文件夹下的文件作为MCP资源公开
- 显示单个MCP提示(
review)它结合了您的审核说明和文件内容
它没有做什么:
- 它不调用任何外部模型API。MCP客户端(VS代码聊天)使用提示和内容生成评论。
先决条件
- Python 3.10+
- Git
安装
python -m venv venv
source venv/bin/activate
pip install -r requirements.txtVS代码配置
在中配置服务器 .vscode/mcp.json 通过设置环境变量:
REVIEWER_REPOS:逗号分隔的仓库URL列表,或JSON数组字符串REVIEWER_CONTENT_FOLDER:存储库中要扫描的文件夹(默认值:content)REVIEWER_INSTRUCTIONS:评审准则/说明见review提示
可选(配置文件):
REVIEWER_CONFIG_PATH:JSON配置文件的路径(支持以下键:repo(回购URL列表),repoContentFolder(字符串),prompts(列表),可选instructions)REVIEWER_CONFIG_JSON:与上述架构相同的原始JSON对象字符串
当两者都提供时,环境变量会覆盖来自配置的值。
使用当前工作区仓库(无克隆)
如果要评估当前VS Code工作区中已签出的存储库(而不是克隆远程存储库),请设置:
REVIEWER_USE_WORKSPACE_REPO=1
在此模式下:
- 服务器将工作区文件夹视为存储库根。
- 不
git clone/git pull发生。 - 文件在以下位置公开
REVIEWER_CONTENT_FOLDER.
- 集 REVIEWER_CONTENT_FOLDER=. 公开整个回购。 - 或者将其设置为文档根目录,如 docs 或 content.
示例 .vscode/mcp.json 服务器环境:
{
"servers": {
"reviewer": {
"command": "${workspaceFolder}/venv/bin/python",
"args": ["${workspaceFolder}/server.py"],
"cwd": "${workspaceFolder}",
"env": {
"REVIEWER_USE_WORKSPACE_REPO": "1",
"REVIEWER_CONTENT_FOLDER": "."
},
"type": "stdio"
}
}
}笔记:
- 您仍然可以设置
REVIEWER_WORKSPACE_ROOT如果您需要服务器在与进程工作目录不同的文件夹上运行。 - 缓存目录仍在以下位置创建
${workspaceRoot}/.repo_cache,但在工作区仓库模式下,它不会用于克隆。
示例config.json(多仓库)
{
"repo": [
"https://github.com/org/repo1.git",
"https://github.com/org/repo2.git"
],
"repoContentFolder": "content",
"prompts": [
"/spelling-and-grammar",
"/full-devex-assessment"
]
}所有存储库共享相同的内容 repoContentFolder 设置。所有存储库中的文件都作为MCP资源公开,并可通过以下方式搜索 list_repository_files.
快速解决量规问题
如果您的配置文件包括 prompts (例如。 "/spelling-and-grammar"),服务器将尝试使用VS Code用户设置将它们解析为实际的提示文件 chat.promptFilesLocations.
- 在macOS上默认情况下,它显示:
~/Library/Application Support/Code/User/settings.json - 用以下内容覆盖设置位置:
REVIEWER_VSCODE_SETTINGS_PATH
服务器将使用以下候选项在每个启用的提示根下查找文件:
- `
.md, .txt`
- `
/index.md, /index.txt`
如果提示无法解决,它仍将列在 评分标准 但其内容不会被嵌入。
开发人员评估提示(MCP触发)
在下找到的任何提示文件 chat.promptFilesLocations 其标题以开头 Developer Assessment 或 Full DevEx Assessment 自动显示为MCP提示。
这使得这些提示“MCP原生”:在聊天中选择它们需要经过MCP服务器(因此回购资源和 list_repository_files 工具可用),生成的提示包括显式 MCP使用 部分。
此repo包含以下示例 .vscode/mcp.json.
用法
- 使用MCP工具
list_repository_files查找文件。 - 使用MCP提示
review随着file_path(路径相对于REVIEWER_CONTENT_FOLDER).
备注
- 存储库缓存在
.repo_cache/在活动工作区根目录中. - 如果您的MCP服务器安装在一个文件夹中,但您希望在不同的VS Code工作区下签出存储库,请设置
REVIEWER_WORKSPACE_ROOT到该工作区文件夹。 - 如果仓库需要身份验证,请首选凭据管理器/SSH。避免在URL中嵌入令牌,因为它们最终可能会出现在日志中。
