使用说明

项目简介

CircleCI MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，旨在为大型语言模型 (LLM) 客户端提供与 CircleCI 集成的上下文信息和功能。通过此服务器，用户可以使用自然语言在 LLM 客户端（如 Cursor IDE）中执行 CircleCI 相关任务，例如获取构建失败日志，从而提升开发效率和问题排查速度。

主要功能点

检索构建失败日志: 提供 'get_build_failure_logs' 工具，用于从 CircleCI 获取详细的构建失败日志，帮助用户快速定位和解决构建问题。
多种日志获取方式: 支持通过以下两种方式获取构建日志：
- CircleCI URL: 直接提供失败的 CircleCI 任务或流水线 URL。
- 本地项目上下文: 在本地工作区中，通过提供工作区根目录、Git 远程 URL 和分支名称来自动检测项目信息。

安装步骤

环境准备: 确保已安装 pnpm 包管理器和 Node.js (>= v18.0.0)。
获取 CircleCI API Token: 访问 CircleCI API Tokens 页面创建或获取您的 CircleCI API Token。
配置 MCP 客户端: 将以下 JSON 配置添加到您的 MCP 客户端（例如 Cursor IDE）的 MCP 服务器配置中。

服务器配置

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "npx",
      "args": ["-y", "@circleci/mcp-server-circleci"],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token"
      }
    }
  }
}

'command': 启动 MCP 服务器的命令，通常设置为 'npx'，用于执行 npm 包。
'args': 传递给 'command' 的参数列表。
- '-y': 自动确认执行 'npx' 命令时的所有提示，避免交互式等待。
- '@circleci/mcp-server-circleci': 指定要执行的 npm 包名称，即 CircleCI MCP Server 包。
'env': 环境变量配置。
- 'CIRCLECI_TOKEN': 重要用于身份验证的 CircleCI API Token。请务必将 'your-circleci-token' 替换为您在 CircleCI 网站上获取的真实 API Token。

基本使用方法

启动服务器: 在 MCP 客户端中配置好服务器信息后，启动 'circleci-mcp-server'。
自然语言指令: 在 LLM 客户端中使用自然语言输入指令，例如：
- 'Find the latest failed pipeline on my branch and get logs' (查找我当前分支上最新的失败流水线并获取日志)
- 'Get logs from https://app.circleci.com/pipelines/github/org/repo/123' (获取来自 'https://app.circleci.com/pipelines/github/org/repo/123' 的日志)
查看结果: 服务器将调用 'get_build_failure_logs' 工具，并返回格式化的构建失败日志，您可以在 LLM 客户端中查看和分析日志内容。

请确保您的 CircleCI API Token 具有读取项目信息的权限，以便服务器能够成功访问 CircleCI API 并检索构建日志。

关键词