Gitlab MCP

🚀 GitLab API Documentation

This documentation provides a detailed guide on using the GitLab API, including how to manage projects, groups, labels, and configure environment variables.

🚀 Quick Start

Before using the GitLab API, you need to set the following environment variables:

GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token
GITLAB_API_URL=your_gitlab_api_url  # Default: https://gitlab.com/api/v4
GITLAB_READ_ONLY_MODE=true          # Optional: Enable read-only mode

✨ Features

• Project Management: Retrieve and create projects.
• Group Project Management: Get projects within a specific group.
• Label Management: List project labels.
• Environment Variable Configuration: Set necessary environment variables for API access.

📦 Installation

No specific installation steps are required for using the API. Just ensure the environment variables are correctly set.

💻 Usage Examples

Project List

Get a Single Project

• Endpoint: /projects/{project_id}
• Method: GET
• Parameters:
  • include_subgroups: Whether to include projects from subgroups, default is false.
  • statistics: Whether to return project statistics, optional values: true or false.

Create a New Project

• Endpoint: /projects
• Method: POST
• Request Body:

{
    "name": string,
    "description": string,
    "visibility": string,
    "namespace": string,
    "ssh_url": string,
    "http_url": string,
    "auto_clone": boolean
}

Group Project List

Get Projects in a Single Group

• Endpoint: /groups/{group_id}/projects
• Method: GET
• Parameters:
  • include_subgroups: Whether to include projects from subgroups, default is false.
  • search: Search keyword to filter by project name or description.
  • archived: Whether to include archived projects, default is false.

Label Management

List Project Labels

• Endpoint: /projects/{project_id}/labels
• Method: GET
• Parameters:
  • with_counts: Whether to include the number of issues and merge requests for each label, default is false.
  • include_ancestor_groups: Whether to include labels from ancestor groups, default is false.

📚 Documentation

This README serves as the main documentation for the GitLab API usage. It covers the main endpoints and parameters for project, group project, and label management.

📄 License

This project is licensed under the MIT License.