使用说明
项目简介
GitLab MR MCP 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为 AI 智能体提供与 GitLab 仓库交互的能力。通过此服务器,AI 智能体可以获取 GitLab 项目信息、合并请求 (Merge Request) 和 Issue 的详细信息,并进行评论等操作,从而辅助代码审查、项目协作等场景。
主要功能点
- 获取项目列表: 列出用户有权访问的 GitLab 项目。
- 查看合并请求: 获取指定项目中所有打开的合并请求列表。
- 获取合并请求详情: 获取指定合并请求的详细信息,例如标题、描述、状态、链接等。
- 获取合并请求评论: 获取合并请求中的所有评论,包括普通评论和代码 Diff 评论。
- 添加合并请求评论: 在指定的合并请求中添加普通评论。
- 添加代码行评论: 在合并请求的代码 Diff 中,针对特定代码行添加评论。
- 获取合并请求 Diff: 获取合并请求的代码变更 Diff 信息。
- 获取 Issue 详情: 获取指定 Issue 的详细信息,例如标题、描述等。
安装步骤
通过 Smithery 自动安装 (推荐 Claude Desktop 用户)
如果您使用 Claude Desktop 等 MCP 客户端,可以通过 Smithery 快速安装:
-
打开终端,运行以下命令,将 'YOUR_GITLAB_TOKEN' 替换为您的 GitLab Personal Access Token。
npx -y @smithery/cli@latest install @kopfrechner/gitlab-mr-mcp --client claude --config '"{\"gitlabMrMcpToken\":\"YOUR_GITLAB_TOKEN\"}"'
手动安装
-
前提条件:
- 已安装 Node.js 环境。
- 已获取 GitLab Personal Access Token,并确保 Token 具有 'api' 和 'read_api' 权限。
- 已知晓要操作的 GitLab 项目的 Project ID。
-
克隆仓库:
git clone https://github.com/kopfrechner/gitlab-mr-mcp.git cd gitlab-mr-mcp -
安装依赖:
npm install
服务器配置
在您的 MCP 客户端配置中,添加以下 JSON 配置信息。请根据实际情况修改 'command' 和 'args' 中的路径,并将 'MR_MCP_GITLAB_TOKEN' 环境变量设置为您的 GitLab Personal Access Token。
{ "mcpServers": { "gitlab-mr-mcp": { // 服务器名称,可以自定义 "command": "node", // 启动服务器的命令,这里使用 node "args": ["/path/to/gitlab-mr-mcp/index.js"], // index.js 脚本的绝对路径,请替换为实际路径 "env": { "MR_MCP_GITLAB_TOKEN": "your_gitlab_token" // GitLab Personal Access Token 环境变量,请替换为您的 Token } } } }
注意:
- '/path/to/gitlab-mr-mcp/index.js' 需要替换为 'index.js' 文件在您本地文件系统中的绝对路径。例如,如果您将仓库克隆到 '/Users/yourname/gitlab-mr-mcp',则应修改为 '/Users/yourname/gitlab-mr-mcp/index.js'。
- 'your_gitlab_token' 需要替换为您在 GitLab 上生成的 Personal Access Token。请确保该 Token 具有 'api' 和 'read_api' 权限。
基本使用方法
配置完成后,您的 MCP 客户端应该能够连接到 GitLab MR MCP 服务器。您可以使用客户端提供的界面或命令,调用服务器提供的各种工具 (Tools) 来与 GitLab 进行交互。
例如,您可以使用 'get_projects' 工具获取项目列表,使用 'get_merge_request_details' 工具获取合并请求的详细信息,等等。具体工具的使用方法请参考 MCP 客户端的文档。
重要提示: 请务必妥善保管您的 GitLab Personal Access Token,避免泄露。
信息
分类
开发者工具