summaryrefslogtreecommitdiff
path: root/servers/gitlab_glab/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'servers/gitlab_glab/README.md')
-rw-r--r--servers/gitlab_glab/README.md89
1 files changed, 89 insertions, 0 deletions
diff --git a/servers/gitlab_glab/README.md b/servers/gitlab_glab/README.md
new file mode 100644
index 0000000..21f40cb
--- /dev/null
+++ b/servers/gitlab_glab/README.md
@@ -0,0 +1,89 @@
+# GitLab CLI MCP Server
+
+This MCP server provides integration with GitLab through the GitLab CLI (`glab`) tool. It allows LLM agents to interact with GitLab repositories and resources using the GitLab API.
+
+## Features
+
+- Check if the GitLab CLI is available and accessible
+- Find GitLab projects by name and retrieve their IDs
+- More features to be added in the future
+
+## Prerequisites
+
+- Python 3.11 or higher
+- GitLab CLI (`glab`) installed and accessible in the system PATH
+- GitLab account with proper authentication set up via `glab auth login`
+
+## Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/dawids-mcp-servers.git
+cd dawids-mcp-servers
+
+# Install the server
+cd servers/gitlab_glab
+uv pip install -e .
+```
+
+## Usage
+
+### Running the server with stdio transport (for local development)
+
+```bash
+mcp-gitlab-glab --transport stdio
+```
+
+### Running the server with remote transport
+
+```bash
+mcp-gitlab-glab --transport remote --host 0.0.0.0 --port 8080
+```
+
+## Available Tools
+
+### check_glab_availability
+
+Checks if the GitLab CLI tool is installed and accessible.
+
+```python
+result = use_mcp_tool(
+ server_name="gitlab_glab",
+ tool_name="check_glab_availability",
+ arguments={}
+)
+```
+
+### find_project
+
+Finds a GitLab project by name and returns its ID and other details.
+
+```python
+result = use_mcp_tool(
+ server_name="gitlab_glab",
+ tool_name="find_project",
+ arguments={
+ "project_name": "my-project"
+ }
+)
+```
+
+## Development
+
+### Running tests
+
+```bash
+cd servers/gitlab_glab
+uv run pytest
+```
+
+### Running tests with coverage
+
+```bash
+cd servers/gitlab_glab
+uv run pytest --cov=mcp_server_gitlab_glab
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.