Overview
What is CircleCI MCP Server?
CircleCI MCP Server is a Model Context Protocol (MCP) server that lets you use natural language to accomplish tasks with CircleCI through MCP clients like Cursor IDE. It provides tools for interacting with CircleCI builds, pipelines, tests, and configuration.
How to use CircleCI MCP Server?
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.
Key features of CircleCI MCP Server
- 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.
Use cases of CircleCI MCP Server
- Debug failed builds and analyze step-by-step execution logs.
- Find and investigate flaky tests in your test suite.
- Check the status of the latest pipeline without leaving your IDE.
- Analyze test results, including failed and slow tests.
- Validate CircleCI config files before pushing.
FAQ from CircleCI MCP Server
What are the requirements to use CircleCI MCP Server?
You need Node.js >= v18.0.0, pnpm package manager, and a CircleCI API token.
How do I generate a CircleCI API token?
You can generate one through CircleCI at https://app.circleci.com/settings/user/tokens or learn more at https://circleci.com/docs/managing-api-tokens/.
How do I configure CircleCI MCP Server for Cursor IDE?
Add a configuration entry in your Cursor MCP config with command npx -y @circleci/mcp-server-circleci and the CIRCLECI_TOKEN environment variable.
Is there support for on-prem CircleCI customers?
Yes, you can set the optional CIRCLECI_BASE_URL environment variable to your on-prem instance URL.
What clients are supported?
Cursor, VS Code, Claude Desktop, Claude Code, Windsurf, and installation via Smithery are supported.
