使用说明
项目简介
tfs-cr-mcp-server 是一个基于 Model Context Protocol (MCP) 构建的服务器应用,专注于为代码审查流程提供上下文信息和自动化能力。它集成了与 Team Foundation Server (TFS) 和 Git 相关的工具,能够获取代码仓库信息、生成代码差异以及推送审查报告,并通过 Prompt 模板支持定制化的代码审查交互模式。
主要功能点
- 提供 get-tfs-pr-ref-names 工具,用于获取 TFS 拉取请求的源分支和目标分支名称。
- 提供 generate-git-diff 工具,用于生成指定分支间的代码差异 diff 信息。
- 提供 push-code-review-report 工具,用于将代码审查报告推送到 TFS 拉取请求的评论中。
- 提供 code-review Prompt 模板,结合代码差异 diff 信息,生成代码审查报告。
安装步骤
- 确保已安装 Node.js 和 npm。
- 克隆仓库到本地:
git clone https://github.com/KeithMo0425/tfs-cr-mcp-server.git - 进入仓库目录:
cd tfs-cr-mcp-server - 安装依赖:
npm install - 编译 TypeScript 代码:
npm run build
服务器配置
MCP客户端需要配置以下信息以连接到 tfs-cr-mcp-server:
{ "serverName": "tfs-code-review-server", "command": "node", "args": [ "dist/index.js" ] }
- 'serverName': 服务器名称,可以自定义,用于在MCP客户端中标识该服务器。例如 "tfs-code-review-server"。
- 'command': 启动服务器的命令,这里使用 'node' 运行 JavaScript 代码。
- 'args': 传递给启动命令的参数,'dist/index.js' 是编译后的服务器入口文件路径。
基本使用方法
- 启动 MCP 服务器:在仓库根目录下执行 'npm start'。服务器将通过 stdio 监听 MCP 客户端的请求。
- 配置 MCP 客户端:在 MCP 客户端中,添加上述服务器配置信息。客户端将使用 JSON-RPC 协议通过 stdio 与服务器通信。
- 调用工具和 Prompt:客户端可以通过 "ListTools" 和 "ListPrompts" 请求获取服务器提供的工具和 Prompt 列表,并使用 "CallTool" 和 "GetPrompt" 请求调用具体的工具和 Prompt,实现代码审查相关的功能。例如,可以调用 'generate-git-diff' 工具获取代码差异,然后使用 'code-review' Prompt 模板结合差异信息生成代码审查报告。
注意:
- 确保在运行服务器前已配置好环境变量 'TFS_URL' 和 'TFS_TOKEN',用于 TFS API 的访问认证。
信息
分类
开发者工具