Skip to content

Setup Wizard

The interactive setup wizard (gitlab-mcp setup) guides you through configuring GitLab MCP for your environment. It auto-detects installed clients, Docker availability, and existing configurations.

Quick Start

bash
npx @structured-world/gitlab-mcp setup

How It Works

The wizard runs through four phases:

Phase 1: Discovery

Automatically detects:

  • Installed MCP clients (Claude Desktop, Cursor, VS Code, etc.)
  • Existing gitlab-mcp configurations
  • Docker/Podman availability
  • Running gitlab-mcp containers

Phase 2: Mode Selection

Based on discovery results, you choose a setup mode:

ModeDescriptionWhen to Use
Configure existingModify an existing setupAlready have gitlab-mcp configured
New local (stdio)Install to AI IDE clientsPersonal use with Claude, Cursor, etc.
New server (HTTP/SSE)Docker-based deploymentTeam access, shared instance

Phase 3: Flow Execution

Local Setup Flow

  1. GitLab instance — Choose gitlab.com or enter self-hosted URL
  2. Authentication — Enter or create a Personal Access Token
  3. Connection test — Verify token and API connectivity
  4. Tool configuration — Choose a preset or manually select tool groups
  5. Client selection — Pick which MCP clients to configure
  6. Installation — Write configuration to selected clients

Server Setup Flow

  1. Docker check — Verify Docker and Compose are available
  2. Deployment type — Standalone, external PostgreSQL, or Compose bundle
  3. Port configuration — Choose the SSE/HTTP port
  4. OAuth setup — Optional multi-user authentication
  5. Tool configuration — Select enabled tool groups
  6. Docker config — Generate docker-compose.yml and .env
  7. Start container — Optionally launch the service immediately

Configure Existing Flow

  1. Detect current setup — Find configured clients and containers
  2. Select target — Choose what to modify
  3. Update configuration — Change tokens, URLs, tool groups, or presets

Phase 4: Summary

Displays what was configured and next steps.

Command Aliases

CommandEquivalent To
gitlab-mcp initgitlab-mcp setup --mode=local
gitlab-mcp docker initgitlab-mcp setup --mode=server

Tool Configuration

During setup, you choose how to configure enabled tools:

Preset Mode

Select from predefined role-based presets:

PresetDescription
developerStandard development tools (default)
senior-devExtended tools for senior engineers
full-accessAll available tools
devopsCI/CD, pipelines, deployments
code-reviewerMerge requests, code review tools
readonlyRead-only browsing tools only

Manual Mode

Toggle individual tool categories:

CategoryTools
LabelsLabel management
Merge RequestsMR operations
FilesFile browsing and management
VariablesCI/CD variables
Work ItemsIssues, epics, tasks
WebhooksWebhook management
SnippetsCode snippets
Integrations50+ project integrations
WikiWiki pages
MilestonesMilestone tracking
PipelinesPipeline and CI/CD jobs
ReleasesRelease management
RefsBranch and tag management
MembersTeam member management
SearchCross-project search

Advanced Mode

Directly set environment variables for fine-grained control over timeouts, retries, denied tools regex, and more.

Examples

bash
# Full interactive wizard
npx @structured-world/gitlab-mcp setup

# Skip to local setup (stdio for IDE clients)
npx @structured-world/gitlab-mcp init

# Skip to server setup (Docker/HTTP)
npx @structured-world/gitlab-mcp docker init

Next Steps

Released under the Apache 2.0 License.