
CircleCI MCP Server

2025.05.06
0
TypeScriptCI/CD自然语言处理开发工具开发效率
CircleCI MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,旨在通过自然语言处理帮助开发者在 CircleCI 平台上完成各种任务。它允许用户通过 Cursor IDE 或其他 MCP 客户端使用自然语言指令来查询构建日志、识别不稳定测试、获取最新管道状态等。
View on GitHub
Overview
基本能力
产品定位
CircleCI MCP Server 是一个为 CircleCI 平台设计的 MCP 服务,旨在通过自然语言处理简化开发者在 CI/CD 流程中的操作和调试。
核心功能
- 获取构建失败日志:支持通过 URL 或本地项目上下文获取详细的构建失败日志。
- 识别不稳定测试:分析测试执行历史,识别并报告不稳定的测试。
- 获取最新管道状态:查询指定分支的最新管道状态,包括工作流状态和持续时间。
- 获取作业测试结果:从 CircleCI 作业中提取测试元数据,便于分析测试结果。
- 配置助手:帮助验证和优化 CircleCI 配置文件。
- 创建提示模板:为 AI 应用生成结构化的提示模板。
- 推荐提示模板测试:为提示模板生成测试用例,确保其稳定性和可靠性。
适用场景
- 调试构建失败:快速获取失败构建的详细日志,无需离开 IDE。
- 测试优化:识别和修复不稳定的测试,提高测试套件的可靠性。
- 管道监控:实时监控管道状态,及时发现问题。
- 配置验证:在推送前验证 CircleCI 配置文件的正确性。
- AI 应用开发:为 AI 功能生成和测试提示模板。
工具列表
get_build_failure_logs
:获取构建失败日志。find_flaky_tests
:识别不稳定测试。get_latest_pipeline_status
:获取最新管道状态。get_job_test_results
:获取作业测试结果。config_helper
:配置助手。create_prompt_template
:创建提示模板。recommend_prompt_template_tests
:推荐提示模板测试。
常见问题解答
- 如何获取 CircleCI API 令牌?:可以通过 CircleCI 设置页面生成 API 令牌。
- 支持哪些客户端?:支持 Cursor IDE、VS Code、Claude Desktop、Claude Code 和 Windsurf。
- 如何调试?:可以使用 MCP Inspector 进行调试。
使用教程
使用依赖
- pnpm:包管理器。
- Node.js:版本 >= v18.0.0。
- CircleCI API 令牌:用于认证。
安装教程
- Cursor:
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" } } } }
- VS Code:
json { "inputs": [ { "type": "promptString", "id": "circleci-token", "description": "CircleCI API Token", "password": true } ], "servers": { "circleci-mcp-server": { "type": "stdio", "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "${input:circleci-token}" } } } }
- Claude Desktop:
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" } } } }
- Claude Code:
bash claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -- npx -y @circleci/mcp-server-circleci
- Windsurf:
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" } } } }
- Smithery:
bash npx -y @smithery/cli install @CircleCI-Public/mcp-server-circleci --client claude
调试方式
- 启动开发服务器:
bash pnpm watch
- 启动 MCP Inspector:
bash pnpm inspector
- 配置环境变量:
- 添加
CIRCLECI_TOKEN
到环境变量部分。 - 可选设置
CIRCLECI_BASE_URL
,默认为https://circleci.com
。 - 运行测试:
bash pnpm test
bash pnpm test:watch