MCP Server Circleci

🚀 CircleCI Server

CircleCI Server is an MCP (Multi-Language Platform Computing) server that supports multiple tools, aiming to enhance developers' work efficiency by integrating into various development environments.

🚀 Quick Start

Getting Started

1. Clone the repository:

git clone https://github.com/CircleCI-Public/mcp-server-circleci.git
cd mcp-server-circleci

2. Install dependencies:

pnpm install

3. Build the project:

pnpm build

Development with MCP Inspector

The easiest way to iterate on the MCP server is to use the MCP Inspector. For more information about the MCP Inspector, visit https://modelcontextprotocol.io/docs/tools/inspector

1. Run the development server:

pnpm watch # Keep this terminal running

2. Start the inspector in another terminal:

pnpm inspector

3. Configure the environment:

• Add your CIRCLECI_TOKEN in the "Environment Variables" section of the inspector UI.
• The token needs read access to your CircleCI projects.
• Optionally, you can set the CircleCI base URL. The default is https://circleci.com.

Testing

• Run the test suite:

pnpm test

• Run watch tests during development:

pnpm test:watch

For more detailed contribution guidelines, see CONTRIBUTING.md

✨ Features

Supported Functions

• Get Build Failure Logs Retrieve logs of failed builds from CircleCI. This feature can be used in two ways:

1. Use a CircleCI link:

• Provide a link to a failed job or pipeline.
• Example: "Get the build logs for https://app.circleci.com/pipelines/github/org/repo/123".

2. Use the local project context:

• Retrieve information from the local workspace by specifying the workspace root path, Git remote URL, and branch name.
• Example: "Find the latest failed pipeline on the current branch".

The tool returns formatted logs, including:

• Job name
• Detailed information about the execution steps
• Failure messages and context

This is very useful for debugging build failures, analyzing test failures, investigating deployment issues, and quickly accessing build logs without leaving the IDE.

• Find Flaky Tests Identify flaky tests in CircleCI projects by analyzing test execution history. This feature utilizes CircleCI's flaky test detection feature described here: https://circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detection

This tool can be used in two ways:

1. Use a CircleCI project link:

• Provide the link to the project directly.
• Example: "Find flaky tests in https://app.circleci.com/pipelines/github/org/repo".

2. Use the local project context:

• Retrieve information from the local workspace by specifying the workspace root path and Git remote URL.
• Example: "Find flaky tests in the current project".

The tool returns detailed information, including:

• Test name and file location
• Failure messages and context

This helps with:

• Identifying unstable tests in the test suite

• Getting detailed context about test failures

• Making data-driven decisions to improve testing

• Configuration Assistant Assist with CircleCI configuration tasks by providing guidance and validation. This tool helps you:

1. Validate the CircleCI configuration:

• Check the .circleci/config.yml file of the project for syntax or semantic errors.
• Example: "Validate my CircleCI configuration".

The tool provides:

• Detailed validation results
• Configuration suggestions

This helps with:

• Catching configuration errors before pushing
• Learning best practices for CircleCI configuration
• Debugging configuration issues
• Correctly implementing CircleCI features