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