☰
CircleCI MCP Server MCP 服务说明文档
2026/10/9 5:23:52 网站建设 项目流程

1. 服务概述

一句话简介:CircleCI官方MCP服务器,通过自然语言与CircleCI管道和项目交互,无需离开IDE即可管理CI/CD流程。

  • 服务名称:CircleCI MCP Server
  • 版本号:未明确提供
  • 开发者/提供方:CircleCI-Public(官方)
  • 协议类型:MCP (Model Context Protocol)

2. 核心功能

该MCP服务提供的主要功能点:

  • 调试构建失败:从CircleCI构建中检索详细的失败日志
  • 识别不稳定测试:分析测试执行历史以查找有问题的测试
  • 检查管道状态:获取特定分支或项目的最新管道状态
  • 检索测试结果:获取测试元数据,包括详细的失败分析
  • 验证CircleCI配置:提供配置指导和验证
  • 列出关注的项目:显示您关注的所有项目及其projectSlugs
  • 运行管道:触发特定分支的管道执行
  • 创建提示模板:为AI应用生成结构化模板
  • 推荐提示测试:生成测试用例以确保预期结果
  • 分析Git差异:根据cursor规则分析git差异以查找违规
  • 下载使用数据:从CircleCI Usage API下载使用数据
  • 查找未充分利用的资源类:查找计算资源使用不足的作业

3. 使用场景

该服务适合在以下情况下使用:

  • CI/CD故障排查:快速诊断构建失败原因,获取详细日志和错误信息
  • 测试质量管理:识别和处理不稳定测试,提高测试套件可靠性
  • 管道监控:实时监控CI/CD管道状态,了解构建进度
  • 配置管理:验证和优化CircleCI配置文件
  • 成本优化:分析资源使用情况,优化计算资源分配
  • AI辅助开发:让AI代理帮助管理和优化CI/CD流程
  • 团队协作:快速共享项目状态和构建信息

4. 接入方式

4.1 服务端点

CircleCI MCP Server支持多种部署方式:

  • NPX本地MCP服务器:使用npx运行本地服务器
  • Docker本地MCP服务器:使用Docker容器运行
  • 自管理远程MCP服务器:部署到远程服务器

4.2 认证与权限

使用该服务需要:

  • CircleCI Personal API token(个人API令牌)
  • 可选:CIRCLECI_BASE_URL(本地部署客户需要)
  • 可选:MAX_MCP_OUTPUT_LENGTH(最大输出长度配置)

4.3 数据格式

服务使用JSON格式进行数据交换:

  • 输入:JSON格式的工具调用参数
  • 输出:JSON格式的执行结果,包括日志、状态、测试结果等

4.4 服务器配置

在Cursor MCP配置中添加服务:

{ "mcpServers": { "circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci@latest"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com", "MAX_MCP_OUTPUT_LENGTH": "50000" } } } }

5. 接口定义

5.1 核心工具

工具名称描述主要功能
get_build_failure_logs获取构建失败日志检索CircleCI构建的详细失败日志
find_flaky_tests识别不稳定测试分析测试执行历史,检测不可靠的测试
get_latest_pipeline_status获取最新管道状态获取特定分支的最新管道状态
get_job_test_results获取作业测试结果检索CircleCI作业的测试元数据和结果
config_helper配置助手验证CircleCI配置并提供指导
list_followed_projects列出关注的项目显示所有您关注的CircleCI项目
run_pipeline运行管道触发管道执行
rerun_workflow重新运行工作流从头或失败的作业重新运行工作流
list_artifacts列出工件列出CircleCI作业生成的工件
analyze_diff分析差异根据cursor规则分析git差异以查找违规
download_usage_api_data下载使用数据从CircleCI Usage API下载使用数据
find_underused_resource_classes查找未充分利用的资源查找计算资源使用不足的作业

6. 快速开始

6.1 环境要求

  • CircleCI Personal API token
  • Node.js >= v18(使用NPX方式)
  • pnpm包管理器
  • Docker(使用Docker方式)

6.2 安装和配置

获取API令牌
# 1. 访问CircleCI设置页面 # 2. 创建Personal API Token # 3. 复制令牌以备后用
在Claude Desktop中配置
{ "mcpServers": { "circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci@latest"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com", "MAX_MCP_OUTPUT_LENGTH": "50000" } } } }
在VS Code中配置
{ "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@latest"], "env": { "CIRCLECI_TOKEN": "${input:circleci-token}" } } } }

6.3 使用示例

查找不稳定测试
# 使用项目slug "Get flaky tests for my-project" # 使用CircleCI项目URL "Find flaky tests in https://app.circleci.com/pipelines/github/org/repo" # 使用本地项目上下文 "Find flaky tests in my current project"
调试构建失败
"Find the latest failed pipeline on my branch and get logs" "Show me the status of my latest pipeline" "Get build failure logs for job xyz"
配置验证
"Validate my CircleCI config" "Help me optimize my .circleci/config.yml"

7. 注意事项

重要提示

  • API令牌安全:妥善保管CircleCI Personal API Token,不要提交到版本控制系统
  • 输出长度限制:默认最大输出长度为50000字符,可通过MAX_MCP_OUTPUT_LENGTH调整
  • 本地部署:本地部署客户需要设置CIRCLECI_BASE_URL
  • 使用数据API:下载使用数据功能仅限云客户使用
  • 资源优化:使用find_underused_resource_classes工具进行成本优化分析
  • 多客户端支持:支持Cursor、Windsurf、Copilot、Claude Desktop、VS Code等多种MCP客户端
  • 许可证:该项目由CircleCI官方维护

需要专业的网站建设服务?

联系我们获取免费的网站建设咨询和方案报价,让我们帮助您实现业务目标

立即咨询