Skip to main content

MCP server for CircleCI

Project description

CircleCI MCP Server

Base URL: https://circleci.com/api/v2

API Info


Install

Quick Start (recommended)

API_KEY_HEADER=YOUR_API_KEY_HEADER \
BASIC_AUTH_USERNAME=YOUR_BASIC_AUTH_USERNAME \
BASIC_AUTH_PASSWORD=YOUR_BASIC_AUTH_PASSWORD \
API_KEY_QUERY=YOUR_API_KEY_QUERY \
uvx mcparmory-circleci

With pip

pip install mcparmory-circleci
API_KEY_HEADER=YOUR_API_KEY_HEADER \
BASIC_AUTH_USERNAME=YOUR_BASIC_AUTH_USERNAME \
BASIC_AUTH_PASSWORD=YOUR_BASIC_AUTH_PASSWORD \
API_KEY_QUERY=YOUR_API_KEY_QUERY \
mcparmory-circleci

MCP Client Configuration

Add to your MCP client config (e.g. Claude Desktop, Cursor, Codex):

{
  "mcpServers": {
    "circleci": {
      "command": "uvx",
      "args": ["mcparmory-circleci"],
      "env": {
        "API_KEY_HEADER": "YOUR_API_KEY_HEADER",
        "BASIC_AUTH_USERNAME": "YOUR_BASIC_AUTH_USERNAME",
        "BASIC_AUTH_PASSWORD": "YOUR_BASIC_AUTH_PASSWORD",
        "API_KEY_QUERY": "YOUR_API_KEY_QUERY"
      }
    }
  }
}

Credentials

Set the following environment variables (via MCP client env config, shell export, or .env file):

  • API_KEY_HEADER — API Key Authentication (Circle-Token)
  • BASIC_AUTH_USERNAME — Username
  • BASIC_AUTH_PASSWORD — Password
  • API_KEY_QUERY — API Key Authentication (circle-token) Do not commit credentials to version control.

Run Locally

First, configure your credentials in .env (see Credentials above).

pip install -r requirements.txt
python server.py

Connect MCP Client

Edit .mcp.json and replace <SERVER_DIR> with the absolute path to this directory, then add to your MCP client configuration.

Example (if server is at /home/user/mcp-servers/circleci):

{
  "mcpServers": {
    "circleci": {
      "command": "python",
      "args": ["/home/user/mcp-servers/circleci/server.py"]
    }
  }
}

Docker

First, configure your credentials in .env (see Credentials above).

docker build -t circleci .
docker run -p 8000:8000 --env-file .env circleci

Before running, make sure ports 8000 are free.For Docker, use SSE transport in your MCP client config:

{
  "mcpServers": {
    "circleci": {
      "type": "sse",
      "url": "http://localhost:8000/sse"
    }
  }
}

Files

  • .env - Credentials and server configuration
  • .mcp.json - MCP client config template
  • Dockerfile - Container build
  • LICENSE - MIT license for this generated code
  • requirements.txt - Python dependencies
  • README.md - This file
  • server.py - MCP server entry point
  • _auth.py - Authentication handlers
  • _models.py - Request/response models
  • _validators.py - Input validation

Note: Files starting with . are hidden by default on macOS/Linux. Use ls -a in terminal or enable "Show hidden files" in your file manager to see .env and .mcp.json.


MCP Blacksmith
Generated by MCP Blacksmith · Quickstart docs · Report a bug

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcparmory_circleci-1.0.2-py3-none-any.whl (79.0 kB view details)

Uploaded Python 3

File details

Details for the file mcparmory_circleci-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mcparmory_circleci-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b171e27bd35912e9fba5162d1313db9afa10d5c90037b264976cba0734b8f7f0
MD5 48a9a87af755b7cdb680bfed37b6b9c1
BLAKE2b-256 37e6b357b6e1547cb0e52deeaf3ad0f8b3aa13272ac6d9ed3d7dc44834e20ade

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page