gitlab-docs

GitLab Docs MCP 服务

一个 Model Context Protocol 服务，可让 AI 助手即时访问 GitLab 官方文档。

功能

• 智能搜索 - 快速搜索所有文档，并按相关性排序
• 按章节筛选 - 定向查找特定领域（CI/CD、API、Admin 等）
• 完整内容访问 - 获取完整的文档页面
• 始终保持最新 - 自动与最新版 GitLab 文档同步
• 通用兼容性 - 适用于任何兼容 MCP 的 AI 助手

安装

此服务适用于任何兼容 MCP 的 AI 助手。Model Context Protocol 通过标准化接口，让 AI 助手能够连接外部工具和数据源。

GitHub Copilot（VS Code）

1. 打开 MCP 配置

按 ⌘+Shift+P（Windows/Linux 上按 Ctrl+Shift+P），输入 MCP: Open User Configuration，然后按 Enter。

2. 添加到 mcp.json：

{
  "servers": {
    "gitlab-docs": {
      "command": "npx",
      "args": ["-y", "gitlab-docs-mcp"]
    }
  }
}

3. 重新加载 VS Code

按 ⌘+Shift+P（或 Ctrl+Shift+P），输入 Developer: Reload Window，然后按 Enter。

替代方式： 你也可以在以下位置手动创建/编辑文件：

• macOS： ~/Library/Application Support/Code/User/mcp.json
• Windows： %APPDATA%\Code\User\mcp.json
• Linux： ~/.config/Code/User/mcp.json

Claude Desktop

Claude Desktop 是 Anthropic 推出的独立桌面应用，支持 MCP 服务。

将以下内容添加到 Claude Desktop 配置文件中：

macOS： ~/Library/Application Support/Claude/claude_desktop_config.json Windows： %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "gitlab-docs": {
      "command": "npx",
      "args": ["-y", "gitlab-docs-mcp"]
    }
  }
}

重启 Claude Desktop。

Cursor IDE

Cursor 内置了 MCP 支持。创建或编辑 MCP 配置文件：

1. 创建/编辑配置文件

• 项目专用： 项目根目录下的 .cursor/mcp.json
• 全局： 主目录下的 ~/.cursor/mcp.json

2. 添加服务配置：

{
  "mcpServers": {
    "gitlab-docs": {
      "command": "npx",
      "args": ["-y", "gitlab-docs-mcp"]
    }
  }
}

3. 重启 Cursor

其他 MCP 客户端

对于其他兼容 MCP 的客户端（Zed、Windsurf 等），请将其配置为运行：

npx -y gitlab-docs-mcp

请参阅客户端的 MCP 配置文档，了解所需的具体格式。

使用方法

配置完成后，只需向 AI 助手询问有关 GitLab 的问题：

对话示例：

You: "How do I set up a CI/CD pipeline in GitLab?"
Assistant: [Searches GitLab docs and provides detailed pipeline configuration guide]

You: "Show me how to configure GitLab Runner on Ubuntu"
Assistant: [Retrieves GitLab Runner installation documentation]

You: "What are the GraphQL mutations for updating issues?"
Assistant: [Searches API docs and shows GraphQL mutation examples]

You: "Explain GitLab's authentication options"
Assistant: [Provides overview from authentication documentation]

AI 助手将自动使用 GitLab Docs MCP 服务搜索文档，并提供准确、最新的答案。

可用工具

searchGitLabDocs

在 2,900 多个 GitLab 文档页面中进行智能排序搜索。

参数：

• query - 搜索词
• maxResults - 最多返回的结果数（默认值：10，最大值：50）
• section - 按章节筛选：ci、api、user、admin、development

getDocPage

获取指定文档页面的完整内容。

参数：

• path - 文档路径（例如："ci/yaml/_index.md"）

listDocSections

浏览可用的文档章节及其结构。

故障排除

服务没有响应？

• 确保已安装 Node.js 22.13+ 或 24+：node --version
• 完全重启 AI 助手/客户端
• 检查应用程序日志，确认是否存在 MCP 连接错误

文档已过时？ 服务会自动使用 npm 上最新发布的版本。只需重启 MCP 客户端即可获取更新。

参与贡献

发现了 Bug 或有功能请求？请访问 GitHub 仓库。

许可证

MIT - 详情请参阅 LICENSE 文件。