CircleCI MCP Server
Description
# CircleCI MCP Server [](https://github.com/CircleCI-Public/mcp-server-circleci/blob/main/LICENSE)…
About
# CircleCI MCP Server [](https://github.com/CircleCI-Public/mcp-server-circleci/blob/main/LICENSE) [](https://dl.circlec…
Details
- Author
- mikeysrecipes
- Downloads
- 193
- Categories
- Other, Automation
Jump to
- Retrieve detailed failure logs from CircleCI builds.
- Identify flaky tests in a CircleCI project.
- Get latest pipeline status for a branch.
- Retrieve test metadata for CircleCI jobs.
- Validate CircleCI configuration and get recommendations.
- Generate structured prompt templates for AI applications.
- Generate test cases for prompt templates.
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
CircleCI MCP ServerCommand (node, npx, python, etc.)Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
From the repository
Install the npm package @circleci/mcp-server-circleci and configure it in your MCP client (Cursor, VS Code, Claude Desktop, Claude Code, Windsurf, or via Smithery). Requires Node.js >=18.0.0, pnpm, and a CircleCI API token set as CIRCLECI_TOKEN. Optionally set CIRCLECI_BASE_URL for on-prem customers.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"circleci mcp server": {
"mcp-server-circleci-mikeysrecipes": {
"command": "npx",
"args": [
"-y",
"@smithery/cli",
"install",
"@CircleCI-Public/mcp-server-circleci",
"--client",
"claude"
]
}
}
}
}McpServers
{
"mcp-server-circleci-mikeysrecipes": {
"command": "npx",
"args": [
"-y",
"@smithery/cli",
"install",
"@CircleCI-Public/mcp-server-circleci",
"--client",
"claude"
]
}
}CircleCI MCP Server
Model Context Protocol (MCP) is a new, standardized protocol for managing context between large language models (LLMs) and external systems. In this repository, we provide an MCP Server for CircleCI.
This lets you use Cursor IDE, or any MCP Client, to use natural language to accomplish things with CircleCI, e.g.:
- Find the latest failed pipeline on my branch and get logs
https://github.com/CircleCI-Public/mcp-server-circleci/wiki#circleci-mcp-server-with-cursor-ide
https://github.com/user-attachments/assets/3c765985-8827-442a-a8dc-5069e01edb74
Requirements
- pnpm package manager - Learn more
- Node.js >= v18.0.0
- CircleCI API token - you can generate one through the CircleCI. Learn more or click here for quick access.
Installation
Cursor
Add the following to your cursor MCP config:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci"],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only
}
}
}
}
See the guide below for more information on using MCP servers with cursor:
https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers
VS Code
To install CircleCI MCP Server for VS Code in .vscode/mcp.json
{
// 💡 Inputs are prompted on first server start, then stored securely by VS Code.
"inputs": [
{
"type": "promptString",
"id": "circleci-token",
"description": "CircleCI API Token",
"password": true
}
],
"servers": {
// https://github.com/ppl-ai/modelcontextprotocol/
"circleci-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci"],
"env": {
"CIRCLECI_TOKEN": "${input:circleci-token}"
}
}
}
}
See the guide below for more information on using MCP servers with VS Code:
https://code.visualstudio.com/docs/copilot/chat/mcp-servers
Claude Desktop
Add the following to your claude_desktop_config.json:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci"],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only
}
}
}
}
To find/create this file, first open your claude desktop settings. Then click on "Developer" in the left-hand bar of the Settings pane, and then click on "Edit Config"
This will create a configuration file at:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json
See the guide below for more information on using MCP servers with Claude Desktop:
https://modelcontextprotocol.io/quickstart/user
Claude Code
After installing Claude Code, run the following command:
claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -- npx -y @circleci/mcp-server-circleci
See the guide below for more information on using MCP servers with Claude Code:
https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp
Windsurf
Add the following to your windsurf mcp_config.json:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci"],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only
}
}
}
}
Installing via Smithery
To install CircleCI MCP Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @CircleCI-Public/mcp-server-circleci --client claude
See the guide below for more information on using MCP servers with windsurf:
https://docs.windsurf.com/windsurf/mcp
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
