Circleci Public MCP Server Circleci

🚀 圈子CI MCP服務器

圈子CI MCP服務器基於模型上下文協議（MCP），這是管理大型語言模型（LLMs）與外部系統間上下文的新標準協議。藉助該服務器，你能使用Cursor IDE或其他MCP客戶端，通過自然語言與CircleCI進行交互，例如查找分支上最新的失敗管道並獲取日誌等。

🚀 快速開始

模型上下文協議（MCP）是用於管理大型語言模型（LLMs）和外部系統之間上下文的新標準協議。本倉庫為CircleCI提供了一個MCP服務器，藉助它，你可以使用Cursor IDE或任何MCP客戶端，通過自然語言完成與CircleCI交互的事情。

✨ 主要特性

支持的工具

• get_build_failure_logs：從CircleCI構建中檢索詳細的失敗日誌。該工具支持兩種使用方式：
  • 使用CircleCI URL：提供一個失敗作業URL或管道URL，例如獲取https://app.circleci.com/pipelines/github/org/repo/123的日誌。
  • 使用本地項目上下文：在本地工作區中使用工作區根路徑、Git遠程URL和分支名稱等信息，例如查找我當前分支上最新的失敗管道。

該工具返回的格式化日誌包含作業名稱、執行步驟的詳細信息、失敗消息和上下文，可用於調試構建失敗、分析測試失敗、調查部署問題以及快速訪問構建日誌而不離開IDE。

📦 安裝指南

先決條件

• pnpm包管理器 - 瞭解更多信息
• Node.js >= v18.0.0
• CircleCI API令牌 - 你可以通過CircleCI生成一個。瞭解更多信息或快速訪問此處

Cursor安裝

將以下內容添加到你的Cursor MCP配置中：

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

查看更多關於使用MCP服務器與Cursor配置的指南：https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers

💻 使用示例

基礎用法

以下是使用get_build_failure_logs工具通過CircleCI URL獲取日誌的示例：

獲取https://app.circleci.com/pipelines/github/org/repo/123的日誌

高級用法

以下是使用get_build_failure_logs工具通過本地項目上下文查找當前分支上最新的失敗管道的示例：

查找我當前分支上最新的失敗管道

📚 詳細文檔

開發

入門

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 inspector迭代MCP服務器的最簡單方法。你可以瞭解有關MCP inspector的更多信息此處

1. 啟動開發服務器：

pnpm watch # 保持此終端運行

2. 在另一個終端啟動inspector：

pnpm inspector

3. 配置環境：
   • 將你的CIRCLECI_TOKEN添加到環境變量部分中。
   • 令牌需要對CircleCI項目具有讀取訪問權限。
   • 可選設置你的CircleCI Base URL。默認為https//circleci.com

貢獻

查看更多關於貢獻的指南：CONTRIBUTING.md

📄 許可證

本項目遵循的許可證信息請查看：GitHub