Gitlab Docs MCP

🚀 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 倉庫。