JinDaGe - gitlab-docs-mcp MCP Details

article

README

🚀 GitLab Docs MCP Server

GitLab Docs MCP Server 是一个模型上下文协议服务器，它能让 AI 助手即时访问 GitLab 的官方文档。

🚀 快速开始

此服务器可与任何支持 MCP 的 AI 助手配合使用。模型上下文协议允许 AI 助手通过标准化接口连接到外部工具和数据源。

✨ 主要特性

智能搜索：可对所有文档进行快速、按相关性排序的搜索。
章节筛选：可针对特定领域（如 CI/CD、API、管理等）进行搜索。
完整内容访问：可检索完整的文档页面。
实时更新：会自动与最新的 GitLab 文档同步。
通用兼容性：可与任何支持 MCP 的 AI 助手配合使用。

📦 安装指南

GitHub Copilot（VS Code）

1. 打开 MCP 配置 按下 ⌘+Shift+P（在 Windows/Linux 系统中按下 Ctrl+Shift+P），输入 MCP: Open User Configuration，然后按下回车键。 2. 添加到 mcp.json 文件中

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

3. 重新加载 VS Code 按下 ⌘+Shift+P（在 Windows/Linux 系统中按下 Ctrl+Shift+P），输入 Developer: Reload Window，然后按下回车键。

另一种方法：你也可以手动在以下路径创建或编辑文件：

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. 添加服务器配置

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

3. 重启 Cursor

其他 MCP 客户端

对于其他支持 MCP 的客户端（如 Zed、Windsurf 等），将它们配置为运行以下命令：

npx -y gitlab-docs-mcp

请参考你所使用客户端的 MCP 配置文档，以获取所需的具体格式。

💻 使用示例

基础用法

配置完成后，你只需向 AI 助手询问有关 GitLab 的问题即可。

示例对话：

你：“如何在 GitLab 中设置 CI/CD 管道？”
助手：[搜索 GitLab 文档并提供详细的管道配置指南]

你：“展示如何在 Ubuntu 上配置 GitLab Runner”
助手：[检索 GitLab Runner 安装文档]

你：“用于更新问题的 GraphQL 突变有哪些？”
助手：[搜索 API 文档并展示 GraphQL 突变示例]

你：“解释 GitLab 的身份验证选项”
助手：[从身份验证文档中提供概述]

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

📚 详细文档

`searchGitLabDocs`

可对 2,494 个 GitLab 文档页面进行智能排序搜索。参数：

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

`getDocPage`

检索特定文档页面的完整内容。参数：

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

`listDocSections`

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

🔧 技术细节

服务器无响应？

确保已安装 Node.js 22 及以上版本：node --version
完全重启你的 AI 助手/客户端
检查应用程序日志中是否存在 MCP 连接错误

文档过时？

服务器会自动使用 npm 上发布的最新版本。只需重启你的 MCP 客户端即可获取更新。

📄 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

贡献说明

如果你发现了 bug 或有功能请求，请访问 GitHub 仓库。

gitlab-docs-mcp