CircleCI MCP Server

CircleCI MCP Server

site icon
2025.04.18 12
TypeScriptCI/CD 工具开发工具开发效率
CircleCI MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于在大型语言模型 (LLMs) 和外部系统之间管理上下文。该服务专门为 CircleCI 设计,允许用户通过自然语言与 CircleCI 交互,例如查找最新的失败管道并获取日志。
View on GitHub

Overview

基本能力

产品定位

CircleCI MCP Server 是一个用于在开发环境中通过自然语言与 CircleCI 交互的工具,旨在提高开发效率和调试体验。

核心功能

  1. 自然语言交互:通过 MCP 协议,用户可以使用自然语言命令与 CircleCI 交互。
  2. 日志检索:支持从 CircleCI 构建中获取详细的失败日志。
  3. 本地项目上下文支持:可以从本地工作区提供上下文信息,如工作区根路径、Git 远程 URL 和分支名称。

适用场景

  1. 调试失败构建:快速获取失败构建的日志,帮助开发者定位问题。
  2. 分析测试失败:通过详细的日志信息分析测试失败原因。
  3. 部署问题调查:检查部署过程中的错误日志。
  4. IDE 集成:无需离开 IDE 即可访问构建日志。

工具列表

  • get_build_failure_logs:从 CircleCI 构建中检索详细的失败日志。
  • 支持通过 CircleCI URL 或本地项目上下文获取日志。
  • 返回格式化的日志,包括作业名称、步骤执行详情和失败消息。

常见问题解答

  1. 如何获取 CircleCI API 令牌?
  2. 可以通过 CircleCI 设置页面生成令牌,了解更多
  3. 如何配置 Cursor IDE 使用该服务?
  4. 参考 Cursor MCP 配置指南

使用教程

使用依赖

  1. pnpm 包管理器bash npm install -g pnpm
  2. Node.js ≥ v18.0.0bash nvm install 18
  3. CircleCI API 令牌
  4. CircleCI 令牌设置页面 生成令牌。

安装教程

  1. Cursor IDE 配置
  2. 在 Cursor 的 MCP 配置中添加以下内容: json { "mcpServers": { "circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "your-circleci-token" } } } }

调试方式

  1. 开发模式bash pnpm watch
  2. MCP 检查器bash pnpm inspector
  3. 测试bash pnpm test bash pnpm test:watch

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。