圈CI服务器

简介

CircleCI服务器是一个支持多种工具的MCP（多语言平台计算）服务器，旨在通过集成到各种开发环境中来提升开发者的工作效率。

支持的功能

• 获取构建失败日志

  从CircleCI中检索构建失败的日志。该功能有两种使用方式：

  1. 使用CircleCI链接：

     • 提供一个失败的任务链接或管道链接
     • 示例："获取https://app.circleci.com/pipelines/github/org/repo/123的构建日志"

  2. 使用本地项目上下文：

     • 通过指定工作区根路径、Git远程URL和分支名称从本地工作区中检索信息
     • 示例："查找当前分支上的最新失败管道"

  该工具返回格式化的日志，包括：

  • 任务名称
  • 执行步骤的详细信息
  • 失败消息和上下文

  这对于调试构建失败、分析测试失败、调查部署问题以及快速访问构建日志而不离开IDE非常有用。

• 查找易变测试

  通过分析测试执行历史，识别CircleCI项目中的易变测试。该功能利用了此处描述的CircleCI的易变测试检测功能：https://circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detection

  该工具有两种使用方式：

  1. 使用CircleCI项目链接：

     • 直接提供项目的链接
     • 示例："查找https://app.circleci.com/pipelines/github/org/repo中的易变测试"

  2. 使用本地项目上下文：

     • 通过指定工作区根路径和Git远程URL从本地工作区中检索信息
     • 示例："查找当前项目中的易变测试"

  工具返回详细信息，包括：

  • 测试名称和文件位置
  • 失败消息和上下文

  这有助于：

  • 识别测试套件中的不稳定测试
  • 获取有关测试失败的详细上下文
  • 做出数据驱动的决策以改进测试

• 配置助手

  通过提供指导和验证来协助CircleCI配置任务。该工具帮助你：

  1. 验证CircleCI配置：
     • 检查项目的.circleci/config.yml文件是否存在语法或语义错误
     • 示例："验证我的CircleCI配置"

  工具提供：

  • 详细的验证结果
  • 配置建议

  这有助于：

  • 在推送之前捕获配置错误
  • 学习CircleCI配置的最佳实践
  • 调试配置问题
  • 正确实施CircleCI功能

开发指南

入门

1. 克隆仓库：

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

2. 安装依赖项：

   pnpm install
   

3. 构建项目：

   pnpm build
   

使用MCP Inspector进行开发

最简单的迭代MCP服务器的方法是使用MCP检查器。有关MCP检查器的更多信息，请访问https://modelcontextprotocol.io/docs/tools/inspector

1. 运行开发服务器：

   pnpm watch # 保持此终端运行
   

2. 在另一个终端中启动检查器：

   pnpm inspector
   

3. 配置环境：

   • 在检查器UI的“环境变量”部分添加你的CIRCLECI_TOKEN
   • 令牌需要对你的CircleCI项目具有读取访问权限
   • 可选地，你可以设置CircleCI基础URL。默认为https//circleci.com

测试

• 运行测试套件：

  pnpm test
  

• 在开发期间运行监视测试：

  pnpm test:watch
  

有关更详细的贡献指南，请参阅CONTRIBUTING.md