diff options
| author | Dawid Rycerz <dawid@rycerz.xyz> | 2025-07-15 11:16:25 +0300 |
|---|---|---|
| committer | Dawid Rycerz <dawid@rycerz.xyz> | 2025-07-15 11:16:25 +0300 |
| commit | b6daa775980253fb9581c891b0c547257339ed88 (patch) | |
| tree | b2f80bc9d3e4e92d6b8943db962b941fb1f77eff /servers/gitlab_python/README.md | |
| parent | 2778e2fd17fc205248a73ba97e6ef23ad26aaed1 (diff) | |
feat: initial gitlab_python mcp
Diffstat (limited to 'servers/gitlab_python/README.md')
| -rw-r--r-- | servers/gitlab_python/README.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/servers/gitlab_python/README.md b/servers/gitlab_python/README.md new file mode 100644 index 0000000..bbd85f7 --- /dev/null +++ b/servers/gitlab_python/README.md @@ -0,0 +1,71 @@ +# GitLab Python MCP Server + +This MCP server provides integration with GitLab through the python-gitlab library. It allows LLM agents to interact with GitLab repositories and resources using the GitLab API directly (no CLI required). + +## Features + +- Find GitLab projects by name and retrieve their IDs +- Search for GitLab issues with various filters +- Create new GitLab issues +- (More features to be added in the future) + +## Prerequisites + +- Python 3.11 or higher +- GitLab account and personal access token + +## Configuration + +The server will attempt to discover GitLab settings in the following order: + +- **Server URL**: Parsed from the current git remote, or from the `GITLAB_URL` environment variable. +- **Token**: Parsed from `~/.config/glab-cli/config.yml` (YAML), or from the `GITLAB_TOKEN` environment variable. + +## Installation + +```bash +# Clone the repository +cd dawids-mcp-servers +``` + +## Usage + +### Running from repository root (recommended) + +```bash +uv --directory /path-to-repo/dawids-mcp-servers/servers/gitlab_python run mcp-gitlab-python --transport stdio + +uv --directory /path-to-repo/dawids-mcp-servers/servers/gitlab_python run mcp-gitlab-python --transport remote --host 0.0.0.0 --port 8080 +``` + +### Alternative: Running from server directory + +```bash +cd servers/gitlab_python +uv run mcp-gitlab-python --transport stdio +uv run mcp-gitlab-python --transport remote --host 0.0.0.0 --port 8080 +``` + +## Available Tools + +### find_project +Finds GitLab projects by name and returns their details. + +### search_issues +Search for GitLab issues with various filters. + +### create_issue +Creates a new GitLab issue and returns its URL. + +## Development + +### Running Tests + +```bash +cd /path/to/servers/gitlab_python +uv run pytest +``` + +## License + +MIT
\ No newline at end of file |
