@mcpflow.io/mcp-gitlab

# GitLab  > 此包由 [MCPFlow](https://mcpflow.io) 打包并发布到npm仓库。 GitLab API支持项目管理。 ## 安装与使用直接使用npx运行: ```bash npx @mcpflow.io/mcp-gitlab ``` 或者先安装后使用: ```bash # 安装 npm install @mcpflow.io/mcp-gitlab # 使用 npx @mcpflow.io/mcp-gitlab ``` ## 使用方法请参考原始仓库的使用说明。 ## 工具函数 ### retrieveContext 从AWS知识库中检索上下文信息 **参数:** - `n`: 检索结果数量 - `query`: 检索查询文本 - `knowledgeBaseId`: AWS知识库ID ### performWebSearch 使用Brave Search API进行网络搜索 **参数:** - `count`: 搜索结果数量 - `query`: 搜索查询文本 - `offset`: 分页偏移量 ### performLocalSearch 使用Brave Local Search API进行本地搜索 **参数:** - `count`: 搜索结果数量 - `query`: 本地搜索查询文本 ### generate_image 使用EverArt生成图片 **参数:** - `model`: 模型ID - `prompt`: 所需图片的文本描述 - `image_count`: 生成图片数量 ### list_allowed_directories 获取允许访问的目录列表 **参数:** ### search_files 在文件系统中搜索文件 **参数:** - `path`: 搜索根目录 - `pattern`: 搜索模式 - `excludePatterns`: 排除模式 ### get_file_info 获取文件或目录的详细信息 **参数:** - `path`: 文件或目录路径 ### search 在Google Drive中搜索文件 **参数:** - `query`: 搜索查询 ## 原始信息 - **开发者:** modelcontextprotocol - **版本:** 1.0.0 - **许可证:** MIT License - **原始仓库:** [modelcontextprotocol/servers/blob/main/src/gitlab](https://github.com/modelcontextprotocol/servers/blob/main/src/gitlab) ## 原始README # GitLab MCP Server MCP Server for the GitLab API, enabling project management, file operations, and more. ### Features - **Automatic Branch Creation**: When creating/updating files or pushing changes, branches are automatically created if they don't exist - **Comprehensive Error Handling**: Clear error messages for common issues - **Git History Preservation**: Operations maintain proper Git history without force pushing - **Batch Operations**: Support for both single-file and multi-file operations ## Tools 1. `create_or_update_file` - Create or update a single file in a project - Inputs: - `project_id` (string): Project ID or URL-encoded path - `file_path` (string): Path where to create/update the file - `content` (string): Content of the file - `commit_message` (string): Commit message - `branch` (string): Branch to create/update the file in - `previous_path` (optional string): Path of the file to move/rename - Returns: File content and commit details 2. `push_files` - Push multiple files in a single commit - Inputs: - `project_id` (string): Project ID or URL-encoded path - `branch` (string): Branch to push to - `files` (array): Files to push, each with `file_path` and `content` - `commit_message` (string): Commit message - Returns: Updated branch reference 3. `search_repositories` - Search for GitLab projects - Inputs: - `search` (string): Search query - `page` (optional number): Page number for pagination - `per_page` (optional number): Results per page (default 20) - Returns: Project search results 4. `create_repository` - Create a new GitLab project - Inputs: - `name` (string): Project name - `description` (optional string): Project description - `visibility` (optional string): 'private', 'internal', or 'public' - `initialize_with_readme` (optional boolean): Initialize with README - Returns: Created project details 5. `get_file_contents` - Get contents of a file or directory - Inputs: - `project_id` (string): Project ID or URL-encoded path - `file_path` (string): Path to file/directory - `ref` (optional string): Branch/tag/commit to get contents from - Returns: File/directory contents 6. `create_issue` - Create a new issue - Inputs: - `project_id` (string): Project ID or URL-encoded path - `title` (string): Issue title - `description` (optional string): Issue description - `assignee_ids` (optional number[]): User IDs to assign - `labels` (optional string[]): Labels to add - `milestone_id` (optional number): Milestone ID - Returns: Created issue details 7. `create_merge_request` - Create a new merge request - Inputs: - `project_id` (string): Project ID or URL-encoded path - `title` (string): MR title - `description` (optional string): MR description - `source_branch` (string): Branch containing changes - `target_branch` (string): Branch to merge into - `draft` (optional boolean): Create as draft MR - `allow_collaboration` (optional boolean): Allow commits from upstream members - Returns: Created merge request details 8. `fork_repository` - Fork a project - Inputs: - `project_id` (string): Project ID or URL-encoded path - `namespace` (optional string): Namespace to fork to - Returns: Forked project details 9. `create_branch` - Create a new branch - Inputs: - `project_id` (string): Project ID or URL-encoded path - `branch` (string): Name for new branch - `ref` (optional string): Source branch/commit for new branch - Returns: Created branch reference ## Setup ### Personal Access Token [Create a GitLab Personal Access Token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) with appropriate permissions: - Go to User Settings > Access Tokens in GitLab - Select the required scopes: - `api` for full API access - `read_api` for read-only access - `read_repository` and `write_repository` for repository operations - Create the token and save it securely ### Usage with Claude Desktop Add the following to your `claude_desktop_config.json`: #### Docker ```json { "mcpServers": { "gitlab": { "command": "docker", "args": [ "run", "--rm", "-i", "-e", "GITLAB_PERSONAL_ACCESS_TOKEN", "-e", "GITLAB_API_URL", "mcp/gitlab" ], "env": { "GITLAB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>", "GITLAB_API_URL": "https://gitlab.com/api/v4" // Optional, for self-hosted instances } } } } ``` ### NPX ```json { "mcpServers": { "gitlab": { "command": "npx", "args": [ "-y", "@modelcontextprotocol/server-gitlab" ], "env": { "GITLAB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>", "GITLAB_API_URL": "https://gitlab.com/api/v4" // Optional, for self-hosted instances } } } } ``` ## Build Docker build: ```bash docker build -t vonwig/gitlab:mcp -f src/gitlab/Dockerfile . ``` ## Environment Variables - `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token (required) - `GITLAB_API_URL`: Base URL for GitLab API (optional, defaults to `https://gitlab.com/api/v4`) ## License This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.