CircleCI MCP Server 服务说明文档
1. 服务概述一句话简介使用自然语言与CircleCI交互的MCP服务器无需离开IDE即可管理CI/CD流程服务名称CircleCI MCP Server版本号最新版本开发者/提供方CircleCI-Public协议类型MCP (Model Context Protocol)2. 核心功能列出该MCP服务提供的主要功能点构建与管道管理run_pipeline触发管道运行get_latest_pipeline_status获取分支的最新管道状态rerun_workflow从头或从失败的作业重新运行工作流run_rollback_pipeline触发项目回滚run_evaluation_tests在CircleCI管道上运行评估测试故障诊断与分析get_build_failure_logs从CircleCI构建中检索详细的失败日志get_job_test_results检索CircleCI作业的测试元数据和结果find_flaky_tests通过分析测试执行历史识别不稳定的测试find_underused_resource_classes查找资源使用不足的作业配置与代码分析config_helper验证CircleCI配置并获取指导analyze_diff根据cursor规则分析git diff以查找违规资源管理list_artifacts列出CircleCI作业生成的产物list_component_versions列出CircleCI组件的所有版本list_followed_projects列出您关注的所有CircleCI项目download_usage_api_data从CircleCI Usage API下载使用数据AI辅助开发create_prompt_template为AI应用程序生成结构化提示模板recommend_prompt_template_tests为提示模板生成测试用例3. 使用场景描述该服务适合在什么情况下使用典型应用场景CI/CD流程管理通过自然语言触发、监控和管理CircleCI管道无需切换到CircleCI界面故障诊断快速获取构建失败日志和测试结果加速问题定位和修复测试质量优化识别不稳定的测试flaky tests提高测试可靠性资源优化分析资源使用情况优化CI/CD成本和性能配置验证验证CircleCI配置文件获取最佳实践建议代码审查分析代码变更确保符合团队规范AI应用开发生成和测试AI应用的提示模板使用分析下载和分析CircleCI使用数据优化资源分配4. 接入方式4.1 服务端点CircleCI MCP Server通过MCP协议进行通信支持三种部署方式NPX本地部署通过npx直接运行无需本地安装Docker本地部署使用Docker容器运行提供隔离环境自管理远程服务器部署到远程服务器通过网络访问4.2 认证与权限使用CircleCI MCP Server需要CircleCI Personal API Token在CircleCI中创建Personal API Token获取API Token并配置到环境变量中确保Token具有所需的权限范围安全提示请妥善保管您的CircleCI API Token不要将其提交到版本控制系统中。建议使用环境变量或安全输入方式传递Token。4.3 数据格式CircleCI MCP Server使用JSON格式进行数据交换请求格式JSON格式的MCP协议消息响应格式CircleCI API返回的JSON数据输出长度限制默认最大输出长度为50000字符可通过环境变量配置4.4 服务器配置配置1使用NPXCursor客户端{ mcpServers: { circleci-mcp-server: { command: npx, args: [-y, circleci/mcp-server-circlecilatest], env: { CIRCLECI_TOKEN: your-circleci-token, CIRCLECI_BASE_URL: https://circleci.com, MAX_MCP_OUTPUT_LENGTH: 50000 } } } }配置2使用DockerCursor客户端{ mcpServers: { circleci-mcp-server: { command: docker, args: [ run, --rm, -i, -e, CIRCLECI_TOKEN, -e, CIRCLECI_BASE_URL, -e, MAX_MCP_OUTPUT_LENGTH, circleci/mcp-server-circleci ], env: { CIRCLECI_TOKEN: your-circleci-token, CIRCLECI_BASE_URL: https://circleci.com, MAX_MCP_OUTPUT_LENGTH: 50000 } } } }配置3使用自管理远程服务器Cursor客户端{ inputs: [ { type: promptString, id: circleci-token, description: CircleCI API Token, password: true } ], servers: { circleci-mcp-server-remote: { url: http://your-circleci-remote-mcp-server-endpoint:8000/mcp } } }配置4使用NPXVS Code客户端{ inputs: [ { type: promptString, id: circleci-token, description: CircleCI API Token, password: true }, { type: promptString, id: circleci-base-url, description: CircleCI Base URL, default: https://circleci.com } ], servers: { circleci-mcp-server: { type: stdio, command: npx, args: [-y, circleci/mcp-server-circlecilatest], env: { CIRCLECI_TOKEN: ${input:circleci-token}, CIRCLECI_BASE_URL: ${input:circleci-base-url} } } } }注意VS Code的Inputs在首次服务器启动时提示然后由VS Code安全存储。配置5使用DockerVS Code客户端{ inputs: [ { type: promptString, id: circleci-token, description: CircleCI API Token, password: true }, { type: promptString, id: circleci-base-url, description: CircleCI Base URL, default: https://circleci.com } ], servers: { circleci-mcp-server: { type: stdio, command: docker, args: [ run, --rm, -i, -e, CIRCLECI_TOKEN, -e, CIRCLECI_BASE_URL, circleci/mcp-server-circleci ], env: { CIRCLECI_TOKEN: ${input:circleci-token}, CIRCLECI_BASE_URL: ${input:circleci-base-url} } } } }5. 接口定义CircleCI MCP Server提供18个强大的工具涵盖CI/CD流程的各个方面5.1 环境变量配置环境变量说明是否必需默认值CIRCLECI_TOKENCircleCI Personal API Token必需-CIRCLECI_BASE_URLCircleCI基础URL可选https://circleci.comMAX_MCP_OUTPUT_LENGTHMCP响应的最大输出长度可选500005.2 工具列表工具名称功能描述analyze_diff根据cursor规则分析git diff以查找违规config_helper验证CircleCI配置并获取指导create_prompt_template为AI应用程序生成结构化提示模板download_usage_api_data从CircleCI Usage API下载使用数据find_flaky_tests通过分析测试执行历史识别不稳定的测试find_underused_resource_classes查找资源使用不足的作业get_build_failure_logs从CircleCI构建中检索详细的失败日志get_job_test_results检索CircleCI作业的测试元数据和结果get_latest_pipeline_status获取分支的最新管道状态list_artifacts列出CircleCI作业生成的产物list_component_versions列出CircleCI组件的所有版本list_followed_projects列出您关注的所有CircleCI项目recommend_prompt_template_tests为提示模板生成测试用例rerun_workflow从头或从失败的作业重新运行工作流run_evaluation_tests在CircleCI管道上运行评估测试run_pipeline触发管道运行run_rollback_pipeline触发项目回滚6. 快速开始6.1 环境要求CircleCI Personal API Token必需用于认证CircleCI APINPX方式Node.js v18和pnpmDocker方式DockerMCP客户端Cursor、Windsurf、Copilot、Claude、VS Code等支持MCP的工具6.2 示例代码快速启动Cursor客户端 - NPX方式# 1. 在CircleCI中创建Personal API Token # 访问CircleCI → User Settings → Personal API Tokens # 创建新的API Token # 2. 配置Cursor MCP # 文件位置~/.cursor/mcp.json (macOS/Linux) # %USERPROFILE%\.cursor\mcp.json (Windows) { mcpServers: { circleci-mcp-server: { command: npx, args: [-y, circleci/mcp-server-circlecilatest], env: { CIRCLECI_TOKEN: your_circleci_token_here } } } } # 3. 重启Cursor # 4. 在Cursor中使用自然语言与CircleCI交互快速启动VS Code客户端 - NPX方式# 1. 在项目根目录创建.vscode/mcp.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-circlecilatest], env: { CIRCLECI_TOKEN: ${input:circleci-token} } } } } # 2. 重启VS Code # 3. 首次启动时会提示输入CircleCI API Token # 4. Token将被VS Code安全存储使用示例# 示例1触发管道运行 用户指令在my-project项目中触发main分支的管道运行 AI行为调用run_pipeline工具触发管道 # 示例2查看管道状态 用户指令查看my-project项目main分支的最新管道状态 AI行为调用get_latest_pipeline_status工具获取状态 # 示例3诊断构建失败 用户指令获取job-123的构建失败日志 AI行为调用get_build_failure_logs工具获取详细日志 # 示例4识别不稳定测试 用户指令找出my-project项目中过去30天的不稳定测试 AI行为调用find_flaky_tests工具分析测试历史 # 示例5验证配置 用户指令验证我的.circleci/config.yml配置文件 AI行为调用config_helper工具验证配置并提供指导 # 示例6优化资源使用 用户指令找出资源使用不足的作业 AI行为调用find_underused_resource_classes工具分析资源使用情况7. 注意事项重要限制和注意事项API Token安全妥善保管CircleCI Personal API Token不要提交到版本控制系统Token权限确保API Token具有执行所需操作的足够权限本地部署要求NPX方式需要Node.js v18和pnpmDocker方式需要Docker环境输出长度限制默认最大输出长度为50000字符可根据需要调整MAX_MCP_OUTPUT_LENGTH本地客户CIRCLECI_BASE_URL仅本地客户需要云端客户使用默认值即可网络访问确保能够访问CircleCI API的网络连接速率限制CircleCI API有速率限制频繁操作可能触发限制错误处理AI助手会自动处理API错误但复杂操作可能需要人工干预测试环境建议先在测试项目中验证功能再应用于生产环境VS Code安全存储VS Code会安全存储输入的敏感信息首次启动时提示输入远程服务器配置使用自管理远程服务器时确保服务器端点可访问