返回 MCP 目录
public公开dns本地运行

custom-gitlab-server

一个基于Model Context Protocol的GitLab API交互服务器,允许AI助手通过自然语言命令执行GitLab操作,如搜索仓库、管理问题、创建分支等。

article

README

🚀 GitLab MCP 服务器指南

GitLab MCP 服务器是集成于 GitLab 的工具,借助 Model Context Protocol(MCP)实现与各类开发工具和服务的交互。开发者能直接从代码仓库获取信息,并与其他服务通信,极大提升开发效率。

🚀 快速开始

GitLab MCP 服务器可助力开发者在 GitLab 生态中更高效地开展开发工作。以下是使用该服务器的基本步骤:

  1. 完成先决条件的环境配置。
  2. 进行服务器的安装与设置。
  3. 运行服务器。
  4. 可根据需求将其集成到其他工具(如Claude Desktop)中。

✨ 主要特性

该服务器具备以下实用功能:

  • 代码仓库访问:可直接从 GitLab 仓库获取代码及相关信息,方便开发者随时查看和使用。
  • 集成开发环境支持:支持与常见 IDE(如 VS Code、IntelliJ IDEA 等)无缝连接,让开发者在熟悉的开发环境中操作。
  • 问题跟踪:能查看和管理 GitLab 项目中的问题和合并请求,及时掌握项目进展。
  • 团队协作:促进团队成员间的协作,提供实时反馈和代码审查,提升团队开发效率。

📦 安装指南

先决条件

在运行 GitLab MCP 服务器前,请确保完成以下环境配置:

  1. 操作系统要求
    • 支持 Node.js 的版本(推荐使用 LTS 版本)。
    • 支持 Windows、macOS 或 Linux 系统。
  2. 工具安装
    • 安装 Node.js 和 npm。
    • 确保系统已安装 Git。
  3. 环境变量配置
    • 配置 GITLAB_PERSONAL_ACCESS_TOKEN:这是用于与 GitLab API 通信的访问令牌,需在 GitLab 账户设置中生成。
    • 可选配置 GITLAB_API_URL:若使用自托管的 GitLab 实例,需指定其 API 地址。

安装步骤

克隆仓库

git clone https://github.com/yourusername/gitlab-mcp-server.git

安装依赖

进入克隆后的项目目录,安装所需依赖:

cd gitlab-mcp-server
npm install

配置环境变量

创建一个 .env 文件,并添加以下内容:

GITLAB_PERSONAL_ACCESS_TOKEN=your_token_here
GITLAB_API_URL=https://gitlab.example.com  # 如果使用自托管,请填写此地址

构建服务器

构建项目并设置为可执行:

npm run build

💻 使用示例

运行服务器

直接运行

使用 Node.js 运行构建后的文件:

node build/index.js

使用 npx

若已全局安装,可直接通过 npx 运行:

npx @yourusername/gitlab-mcp-server

集成(例如 Claude Desktop)

claude_desktop_config.json 中添加以下配置:

使用 npx

{
  "mcpServers": {
    "@yourusername/gitlab-mcp-server": {
      "command": "npx",
      "args": ["-y", "@yourusername/gitlab-mcp-server"],
      "env": {
        "GITLAB_PERSONAL_ACCESS_TOKEN": "...",
        "GITLAB_API_URL": "..."
      }
    }
  }
}

使用本地构建

{
  "mcpServers": {
    "@yourusername/gitlab-mcp-server": {
      "command": "/full/path/to/your/custom-gitlab-server/build/index.js",
      "env": {
        "GITLAB_PERSONAL_ACCESS_TOKEN": "...",
        "GITLAB_API_URL": "..."
      }
    }
  }
}
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端