GitLab Documentation MCP Server

编码与调试

by nunolima

可从多个仓库中搜索和访问 GitLab 文档,支持 full-text search 全文检索

什么是 GitLab Documentation MCP Server

可从多个仓库中搜索和访问 GitLab 文档,支持 full-text search 全文检索

README

GitLab Documentation MCP Server

A Model Context Protocol (MCP) server that provides searchable access to GitLab's official documentation. This server indexes markdown documentation from multiple GitLab OSS repositories and makes it available for AI assistants and other MCP clients.

Features

  • Full-text search across GitLab documentation using SQLite FTS5
  • Version-specific docs - Build for any GitLab version (e.g., 18.7.2) or latest
  • Multiple repositories indexed:
    • GitLab CE/EE (main application)
    • GitLab Runner (CI/CD runner)
    • Omnibus GitLab (installation packages)
    • Gitaly (Git RPC service)
    • GitLab Pages (static sites)
    • GitLab Agent (Kubernetes integration, includes KAS)
  • Optimized Docker image - Uses sparse checkout and filters to minimize size

Building the Docker Image

Find the GitLab Version

Look for the latest patch version for your desired GitLab release:

Build for Specific Version

bash
# Set the GitLab version you want (use full patch version)
GITLAB_VERSION=18.7.2

# Build the image
GITLAB_MINOR=$(echo $GITLAB_VERSION | cut -d. -f1,2)
docker build -f docker/Dockerfile --build-arg GITLAB_VERSION=$GITLAB_VERSION \
    -t gitlab-docs-mcp:$GITLAB_VERSION \
    -t mcp/gitlab-docs-mcp:$GITLAB_VERSION \
    -t gitlab-docs-mcp:$GITLAB_MINOR \
    -t mcp/gitlab-docs-mcp:$GITLAB_MINOR .

# Verify the images were created
echo "\nCreated images:"
docker images | grep gitlab-docs-mcp

# Test the image - initialize and list tools
echo "\nTesting MCP server initialization:"
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}' | \
  docker run -i --rm mcp/gitlab-docs-mcp:$GITLAB_VERSION | jq .

echo "\nListing available tools:"
(echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}'; \
 echo '{"jsonrpc":"2.0","id":2,"method":"tools/list"}') | \
  docker run -i --rm mcp/gitlab-docs-mcp:$GITLAB_VERSION 2>/dev/null | tail -1 | jq .

Build for Latest (Main Branch)

bash
docker build -f docker/Dockerfile \
    -t gitlab-docs-mcp:latest \
    -t mcp/gitlab-docs-mcp:latest .

# Verify the images were created
echo "\nCreated images:"
docker images | grep gitlab-docs-mcp

# Test the image - initialize and list tools
echo "\nTesting MCP server initialization:"
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}' | \
  docker run -i --rm mcp/gitlab-docs-mcp:latest | head -20
echo "\nListing available tools:"
(echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}'; \
 echo '{"jsonrpc":"2.0","id":2,"method":"tools/list"}') | \
  docker run -i --rm mcp/gitlab-docs-mcp:latest 2>/dev/null | tail -1 | jq .```

## Installation

This server is published to the [MCP Community Registry](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.nunolima/gitlab-docs-mcp).

### Prerequisites

- Docker installed and running
- MCP-compatible client (Claude Desktop, Cline, Cursor, etc.)

### Setup Instructions

#### Claude Desktop

1. **Locate your config file**:
   - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
   - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
   - Linux: `~/.config/Claude/claude_desktop_config.json`

2. **Add the server configuration**:
   ```json
   {
     "mcpServers": {
       "gitlab-docs": {
         "command": "docker",
         "args": ["run", "-i", "--rm", "nunolima/gitlab-docs-mcp:18.7"]
       }
     }
   }
  1. Restart Claude Desktop - The server will appear in the MCP tools menu (🔌 icon)

Cline (VS Code Extension)

  1. Open Cline settings in VS Code
  2. Navigate to MCP Servers section
  3. Add this configuration:
    json
    {
      "mcpServers": {
        "gitlab-docs": {
          "command": "docker",
          "args": ["run", "-i", "--rm", "nunolima/gitlab-docs-mcp:18.7"]
        }
      }
    }
    
  4. Reload VS Code window

Cursor

  1. Open Cursor settings
  2. Go to FeaturesModel Context Protocol
  3. Add the server configuration:
    json
    {
      "mcpServers": {
        "gitlab-docs": {
          "command": "docker",
          "args": ["run", "-i", "--rm", "nunolima/gitlab-docs-mcp:18.7"]
        }
      }
    }
    

Version Selection

Choose the version that matches your GitLab deployment:

json
// For GitLab 18.7.x
"args": ["run", "-i", "--rm", "nunolima/gitlab-docs-mcp:18.7"]

// For latest GitLab version
"args": ["run", "-i", "--rm", "nunolima/gitlab-docs-mcp:latest"]

Verification

After setup, verify the server is working:

  1. In Claude Desktop: Look for the 🔌 icon - you should see "gitlab-docs" listed
  2. Test a query: Ask Claude to search GitLab documentation, e.g., "Search GitLab docs for CI/CD pipeline configuration"
  3. Check Docker: Run docker ps -a after making a query to see if the container ran

An good test AI request message is: Using only the "gitlab-docs-mcp" mcp tools as source, what is the latest x.y.z GitLab version covered in the GitLab upgrade notes (doc/update/versions/)?

Troubleshooting

Server not appearing in client:

  • Ensure Docker is running: docker info
  • Check config file JSON is valid (no trailing commas, proper quotes)
  • Restart your MCP client completely

"Cannot connect to Docker daemon" error:

  • Start Docker Desktop
  • Verify Docker is accessible: docker ps

Old documentation version:

Available Tools

Once connected, the server provides these tools (MCP Python SDK v2, structured outputs):

  • search_docs: Full-text search across all GitLab documentation (returns paths, titles, repos)
  • get_doc: Retrieve a specific document by exact path from search results
  • search_and_fetch: Search and return full markdown for each hit in one call

Resources

  • docs://repos: Indexed repository keys
  • docs://{+path}: Full markdown for an indexed document path

Example Queries

Try asking your AI assistant:

  • "Search GitLab docs for how to set up GitLab Runner with Docker"
  • "Find documentation about GitLab CI/CD pipeline syntax"
  • "What does the GitLab documentation say about backup and restore?"
  • "Search for GitLab Pages custom domain configuration"

How It Works

  1. Build time: Clones doc folders from GitLab repositories using sparse checkout
  2. Indexing: Parses markdown files and builds an SQLite FTS5 search index
  3. Runtime: MCP server provides search tools to query the indexed documentation

Versioning Strategy

  • Main GitLab repo: Uses full version tag (e.g., v18.7.2-ee)
  • Omnibus GitLab: Uses full version with +ee suffix (e.g., 18.7.2+ee.0)
  • Other repositories: Use major.minor.0 version (e.g., v18.7.0)
    • This uses the first stable release (.0) for each major.minor version
    • Example: Building GitLab 18.7.2 will use Runner/Gitaly/Pages/Agent v18.7.0

Development

Project Structure

code
python/gitlab-docs-mcp/
├── docker/
│   └── Dockerfile         # Main Dockerfile with version support
├── indexer/
│   └── build_index.py     # Builds search index from markdown files
├── server/
│   └── main.py           # MCP server implementation
├── data/
│   └── docs.db           # SQLite FTS5 database (generated)
└── repos/                # Cloned documentation (generated)

Local Development

bash
# Install dependencies
pip install -r requirements.txt

# Clone repos manually for testing
# (or let Docker handle it)

# Build index
python indexer/build_index.py

# Run server (stdio)
python -m server.main

Integration tests (curl + jq)

test.sh starts the Docker image with Streamable HTTP and validates discover, tools, and resources against MCP protocol 2026-07-28:

bash
# Rebuild image first, then:
./test.sh 19.0.5

# Or against an already-running HTTP server:
MCP_TRANSPORT=streamable-http MCP_HOST=0.0.0.0 MCP_PORT=8000 python -m server.main
MCP_BASE_URL=http://127.0.0.1:8000/mcp ./test.sh

License

MIT License - Copyright (c) 2026 Nuno Lima

This project indexes documentation from GitLab's open source repositories. See individual repository licenses for details.

Acknowledgments

Development of this project was supported by OLX, which provided access to AI-assisted development tools.

常见问题

GitLab Documentation MCP Server 是什么?

可从多个仓库中搜索和访问 GitLab 文档,支持 full-text search 全文检索

相关 Skills

前端设计

by anthropics

Universal
热门

面向组件、页面、海报和 Web 应用开发,按鲜明视觉方向生成可直接落地的前端代码与高质感 UI,适合做 landing page、Dashboard 或美化现有界面,避开千篇一律的 AI 审美。

想把页面做得既能上线又有设计感,就用前端设计:组件到整站都能产出,难得的是能避开千篇一律的 AI 味。

编码与调试
未扫描171.4k

网页应用测试

by anthropics

Universal
热门

用 Playwright 为本地 Web 应用编写自动化测试,支持启动开发服务器、校验前端交互、排查 UI 异常、抓取截图与浏览器日志,适合调试动态页面和回归验证。

借助 Playwright 一站式验证本地 Web 应用前端功能,调 UI 时还能同步查看日志和截图,定位问题更快。

编码与调试
未扫描171.4k

网页构建器

by anthropics

Universal
热门

面向复杂 claude.ai HTML artifact 开发,快速初始化 React + Tailwind CSS + shadcn/ui 项目并打包为单文件 HTML,适合需要状态管理、路由或多组件交互的页面。

在 claude.ai 里做复杂网页 Artifact 很省心,多组件、状态和路由都能顺手搭起来,React、Tailwind 与 shadcn/ui 组合效率高、成品也更精致。

编码与调试
未扫描171.4k

相关 MCP Server

GitHub

编辑精选

by GitHub

热门

GitHub 是 MCP 官方参考服务器,让 Claude 直接读写你的代码仓库和 Issues。

这个参考服务器解决了开发者想让 AI 安全访问 GitHub 数据的问题,适合需要自动化代码审查或 Issue 管理的团队。但注意它只是参考实现,生产环境得自己加固安全。

编码与调试
89.7k

by Context7

热门

Context7 是实时拉取最新文档和代码示例的智能助手,让你告别过时资料。

它能解决开发者查找文档时信息滞后的问题,特别适合快速上手新库或跟进更新。不过,依赖外部源可能导致偶尔的数据延迟,建议结合官方文档使用。

编码与调试
60.2k

by tldraw

热门

tldraw 是让 AI 助手直接在无限画布上绘图和协作的 MCP 服务器。

这解决了 AI 只能输出文本、无法视觉化协作的痛点——想象让 Claude 帮你画流程图或白板讨论。最适合需要快速原型设计或头脑风暴的开发者。不过,目前它只是个基础连接器,你得自己搭建画布应用才能发挥全部潜力。

编码与调试
49.9k

评论