g

gitlab-docs

@ozanmutlu/gitlab-docs
Hosted
0 Stars 21 次浏览 ozanmutlu 更新于 2026-08-23

GitLab documentation search for AI assistants via Model Context Protocol (MCP)

MCP 服务配置

复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用

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

可用工具 (5 个)

该服务在 MCP 协议中暴露的工具,AI 可按需调用

tavily_search 14 个参数 需填 1 项

Search the web for current information on any topic. Use for news, facts, or data beyond your knowledge cutoff. Returns snippets and source URLs.

必填参数:query

tavily_extract 6 个参数 需填 1 项

Extract content from URLs. Returns raw page content in markdown or text format.

必填参数:urls

tavily_crawl 11 个参数 需填 1 项

Crawl a website starting from a URL. Extracts content from pages with configurable depth and breadth.

必填参数:url

tavily_map 8 个参数 需填 1 项

Map a website's structure. Returns a list of URLs found starting from the base URL.

必填参数:url

tavily_research 2 个参数 需填 1 项

Perform comprehensive research on a given topic or question. Use this tool when you need to gather information from multiple sources to answer a question or complete a task. Returns a detailed response based on the research findings.

必填参数:input

服务介绍

GitLab Docs MCP Server

npm version

A Model Context Protocol server that provides AI assistants instant access to GitLab's official documentation.

# Features

  • Intelligent Search - Fast, relevance-ranked search across all docs
  • Section Filtering - Target specific areas (CI/CD, API, Admin, etc.)
  • Full Content Access - Retrieve complete documentation pages
  • Always Up-to-Date - Automatically synced with latest GitLab docs
  • Universal Compatibility - Works with any MCP-compatible AI assistant

# Installation

This server works with any MCP-compatible AI assistant. The Model Context Protocol allows AI assistants to connect to external tools and data sources through a standardized interface.

# # GitHub Copilot (VS Code)

1. Open MCP Configuration

Press ⌘+Shift+P (or Ctrl+Shift+P on Windows/Linux), type MCP: Open User Configuration, and press Enter.

2. Add to mcp.json:

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

3. Reload VS Code

Press ⌘+Shift+P (or Ctrl+Shift+P), type Developer: Reload Window, and press Enter.

Alternative: You can also manually create/edit the file at:

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

# # Claude Desktop

Claude Desktop is a standalone desktop application by Anthropic that supports MCP servers.

Add to your Claude Desktop configuration file:

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"]
    }
  }
}

Restart Claude Desktop.

# # Cursor IDE

Cursor has built-in MCP support. Create or edit the MCP configuration file:

1. Create/Edit Configuration File

  • Project-specific: .cursor/mcp.json in your project root
  • Global: ~/.cursor/mcp.json in your home directory

2. Add Server Configuration:

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

3. Restart Cursor

# # Other MCP Clients

For other MCP-compatible clients (Zed, Windsurf, etc.), configure them to run:

npx -y gitlab-docs-mcp

Refer to your client's MCP configuration documentation for the specific format required.

# Usage

Once configured, simply ask your AI assistant about GitLab:

Example Conversations:

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]

The AI assistant will automatically use the GitLab Docs MCP server to search documentation and provide accurate, up-to-date answers.

# Available Tools

# # searchGitLabDocs

Search across 2,494 GitLab documentation pages with intelligent ranking.

Parameters:

  • query - Search terms
  • maxResults - Maximum results (default: 10, max: 50)
  • section - Filter by section: ci, api, user, admin, development

# # getDocPage

Retrieve the complete content of a specific documentation page.

Parameters:

  • path - Document path (e.g., "ci/yaml/README.md")

# # listDocSections

Browse available documentation sections and their structure.

# Troubleshooting

Server not responding?

  • Ensure Node.js 22+ is installed: node - -version
  • Restart your AI assistant/client completely
  • Check application logs for MCP connection errors

Documentation out of date?
The server automatically uses the latest published version from npm. Simply restart your MCP client to get updates.

# Contributing

Found a bug or have a feature request? Please visit the GitHub repository.

# License

MIT - see LICENSE file for details.

相关 MCP 服务