From 782e0d2c2d09a9157775ccfda085616bcd988792 Mon Sep 17 00:00:00 2001 From: simple Date: Fri, 21 Feb 2025 09:33:30 +0900 Subject: [PATCH] =?UTF-8?q?README.md=EC=97=90=EC=84=9C=20=EA=B8=B0?= =?UTF-8?q?=EB=8A=A5=20=EC=84=B9=EC=85=98=20=EC=A0=9C=EA=B1=B0:=20?= =?UTF-8?q?=EB=B6=88=ED=95=84=EC=9A=94=ED=95=9C=20=EC=A0=95=EB=B3=B4=20?= =?UTF-8?q?=EC=82=AD=EC=A0=9C=20=EB=B0=8F=20=EB=AC=B8=EC=84=9C=20=EA=B0=84?= =?UTF-8?q?=EC=86=8C=ED=99=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 68 ++++++++++++++++++++++++------------------------------- 1 file changed, 30 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index a2b20af..e8c3fd9 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,37 @@ GitLab MCP(Model Context Protocol) Server. **Includes bug fixes and improvements gitlab mcp MCP server -## Features ✨ +## Usage -- **Automatic Branch Creation**: Automatically creates a branch if it doesn't exist when creating/updating files or pushing changes. 🌿 -- **Comprehensive Error Handling**: Provides clear error messages for common issues. ⚠️ -- **Git History Preservation**: Operates without force-pushing, maintaining Git history. πŸ“œ -- **Batch Operations**: Supports both single and multi-file operations. 묢음 -- **Versatile Search**: Supports project search functionality. πŸ” +### Using with Claude App, Cline, Roo Code + +When using with the Claude App, you need to set up your API key and URLs directly. + +```json +{ + "mcpServers": { + "GitLab communication server": { + "command": "npx", + "args": ["-y", "@zereight/mcp-gitlab"], + "env": { + "GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token", + "GITLAB_API_URL": "your_gitlab_api_url" + } + } + } +} +``` + +### Using with Cursor + +When using with Cursor, you can set up environment variables and run the server as follows: + +``` +env GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token GITLAB_API_URL=your_gitlab_api_url npx @zereight/mcp-gitlab +``` + +- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token. +- `GITLAB_API_URL`: Your GitLab API URL. (Default: `https://gitlab.com/api/v4`) ## Tools πŸ› οΈ @@ -159,38 +183,6 @@ GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token GITLAB_API_URL=your_gitlab_api_url # Default: https://gitlab.com/api/v4 ``` -## Usage - -### Using with Claude App, Cline, Roo Code - -When using with the Claude App, you need to set up your API key and URLs directly. - -```json -{ - "mcpServers": { - "GitLab communication server": { - "command": "npx", - "args": ["-y", "@zereight/mcp-gitlab"], - "env": { - "GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token", - "GITLAB_API_URL": "your_gitlab_api_url" - } - } - } -} -``` - -### Using with Cursor - -When using with Cursor, you can set up environment variables and run the server as follows: - -``` -env GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token GITLAB_API_URL=your_gitlab_api_url npx @zereight/mcp-gitlab -``` - -- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token. -- `GITLAB_API_URL`: Your GitLab API URL. (Default: `https://gitlab.com/api/v4`) - ## License MIT License