A powerful Model Context Protocol (MCP) server for GitLab integration, enabling AI assistants to interact with your GitLab resources.

## ✨ Features - **Comprehensive GitLab API Integration** - Access repositories, issues, merge requests, wikis, and more - **Both Transports Supported** - Use with stdio or Server-Sent Events (SSE) - **Consistent Response Formatting** - Standardized pagination and response structures - **Strong TypeScript Typing** - Built with the MCP SDK for type safety - **Complete Documentation** - Examples for all available tools ### 🔍 Supported Operations - **Repository Management** - Search, create, fork repositories - **File Handling** - Read, create, update files - **Branch Operations** - Create and manage branches - **Issue Tracking** - Create, list, filter issues - **Merge Requests** - Create, list, review merge requests - **Group Management** - List group projects and members - **Project Activity** - Track events and commit history - **Wiki Management** - Full support for project and group wikis with attachments - **Member Management** - List and manage project/group members ## 🚀 Getting Started ### Installation #### From npm (Recommended) ```bash npm install @yoda.digital/gitlab-mcp-server ``` #### From Source ```bash # Clone the repository git clone https://github.com/yoda-digital/mcp-gitlab-server.git cd mcp-gitlab-server # Install dependencies npm install # Build the project npm run build ``` ### Configuration #### Environment Variables The server requires the following environment variables: | Variable | Required | Default | Description | | ------------------------------ | -------- | --------------------------- | -------------------------------------------------- | | `GITLAB_PERSONAL_ACCESS_TOKEN` | Yes | - | Your GitLab personal access token | | `GITLAB_API_URL` | No | `https://gitlab.com/api/v4` | GitLab API URL | | `PORT` | No | `3000` | Port for SSE transport | | `USE_SSE` | No | `false` | Set to 'true' to use SSE transport | | `GITLAB_READ_ONLY_MODE` | No | `false` | Set to 'true' to enable read-only mode (see below) | #### Read-Only Mode When `GITLAB_READ_ONLY_MODE` is set to `true`, the server will only expose read operations. This is useful for client applications that shouldn't have write access to your GitLab resources. In read-only mode, the following tools will be available: - `search_repositories` - `get_file_contents` - `list_group_projects` - `get_project_events` - `list_commits` - `list_issues` - `list_merge_requests` - `list_project_wiki_pages` - `get_project_wiki_page` - `list_group_wiki_pages` - `get_group_wiki_page` - `list_project_members` - `list_group_members` Any attempt to use write operations (create, update, delete) will result in an error when in read-only mode. #### MCP Settings Configuration Add the GitLab MCP server to your MCP settings file: ```json { "mcpServers": { "gitlab": { "command": "npx", "args": ["-y", "@yoda.digital/gitlab-mcp-server"], "env": { "GITLAB_PERSONAL_ACCESS_TOKEN": "your_token_here", "GITLAB_API_URL": "https://gitlab.com/api/v4" }, "alwaysAllow": [], "disabled": false } } } ``` For read-only mode, add the `GITLAB_READ_ONLY_MODE` environment variable: ```json { "mcpServers": { "gitlab-readonly": { "command": "npx", "args": ["-y", "@yoda.digital/gitlab-mcp-server"], "env": { "GITLAB_PERSONAL_ACCESS_TOKEN": "your_token_here", "GITLAB_API_URL": "https://gitlab.com/api/v4", "GITLAB_READ_ONLY_MODE": "true" }, "alwaysAllow": [], "disabled": false } } } ``` ### Usage #### With std

GitLab MCP Server

评论