项目简介

GitLab MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在将 GitLab 的强大功能集成到各种 LLM 客户端应用中。通过此服务器,LLM 可以安全、便捷地访问和操作 GitLab 上的项目资源,例如代码仓库、议题 (Issues) 和合并请求 (Merge Requests),从而实现更智能化的 DevOps 流程。

主要功能点

  • 代码仓库操作: 支持搜索 GitLab 仓库、获取文件内容、创建或更新文件、推送文件到仓库、创建分支、Fork 仓库等功能。
  • 议题管理: 支持创建 GitLab 议题。
  • 合并请求管理: 支持创建、查询和更新 GitLab 合并请求,包括查看差异 (Diff)。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统中已安装 Node.js 和 npm。

  2. 全局安装 GitLab MCP Server: 打开终端,运行以下命令安装 GitLab MCP Server。

    npm install -g @harshmaur/gitlab-mcp

    或者使用 npx 直接运行:

    npx @harshmaur/gitlab-mcp

服务器配置

为了让 MCP 客户端(如 Claude、Cursor 等)连接到 GitLab MCP Server,你需要在客户端中配置服务器的启动命令和参数。以下是一个典型的 JSON 配置示例,你需要根据你的 MCP 客户端进行配置:

{
  "mcpServers": {
    "GitLab 通信服务器": {
      "command": "npx",
      "args": ["@harshmaur/gitlab-mcp"],
      "env": {
        "GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
        "GITLAB_API_URL": "https://gitlab.com/api/v4"
      }
    }
  }
}

配置参数说明:

  • '"GitLab 通信服务器"': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器。
  • '"command": "npx"': 启动服务器的命令,这里使用 'npx' 来运行 npm 包。
  • '"args": ["@harshmaur/gitlab-mcp"]': 'npx' 命令的参数,指定要运行的 npm 包为 '@harshmaur/gitlab-mcp'。
  • '"env"': 环境变量配置,用于服务器运行时访问 GitLab API。
    • '"GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token"': 必需配置,你的 GitLab 个人访问令牌 (Personal Access Token),用于 API 鉴权。你需要在 GitLab 中生成具有 'api' 权限的个人访问令牌,并替换 '"your_gitlab_token"'。
    • '"GITLAB_API_URL": "https://gitlab.com/api/v4"': 可选配置,GitLab API 的 URL。如果你的 GitLab 实例不是官方的 'gitlab.com',你需要修改此地址。默认为 'https://gitlab.com/api/v4'。

注意: 请务必将 '"your_gitlab_token"' 替换为你自己的 GitLab 个人访问令牌。

基本使用方法

  1. 启动服务器: 配置完成后,MCP 服务器会在客户端启动时自动运行。你也可以在终端中手动运行 'npx @harshmaur/gitlab-mcp' 来启动服务器。

  2. 在 LLM 客户端中使用工具: 在支持 MCP 协议的 LLM 客户端中,你可以通过自然语言指令调用 GitLab MCP Server 提供的工具,例如:

    • 让 LLM 搜索 GitLab 上包含关键词 "example" 的项目。
    • 让 LLM 在指定的 GitLab 项目中创建一个新的 issue。
    • 让 LLM 获取某个 GitLab 项目中指定文件的内容。

    具体的工具调用方式取决于你使用的 LLM 客户端的功能和界面。请参考你所用客户端的文档来了解如何使用 MCP 服务器提供的工具。

信息

分类

开发者工具