mcp-server-circleci

Official

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Integrates with CircleCI to retrieve build failure logs and identify flaky tests. Supports accessing logs via CircleCI URLs or local project context, and analyzing test execution history to detect unreliable tests in a project's test suite.

CircleCI MCP サーバー

モデルコンテキストプロトコル(MCP)は、大規模言語モデル(LLM)と外部システム間のコンテキストを管理するための新しい標準化プロトコルです。このリポジトリでは、 CircleCI用のMCPサーバーを提供します。

これにより、Cursor IDE または任意の MCP クライアントを使用して、自然言語で CircleCI で次の操作を実行できるようになります。

https://github.com/user-attachments/assets/3c765985-8827-442a-a8dc-5069e01edb74

要件

インストール

カーソル

カーソル 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" // Optional - required for on-prem customers only } } } }

カーソルで MCP サーバーを使用する方法の詳細については、以下のガイドを参照してください: https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers

クロードデスクトップ

claude_desktop_config.json に次の内容を追加します。

{ "mcpServers": { "circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only } } } }

このファイルを見つける/作成するには、まずClaudeデスクトップの設定を開きます。次に、設定パネルの左側のバーにある「開発」をクリックし、「設定の編集」をクリックします。

これにより、次の場所に構成ファイルが作成されます。

  • macOS: ~/ライブラリ/アプリケーションサポート/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Claude Desktop で MCP サーバーを使用する方法の詳細については、以下のガイドを参照してください: https://modelcontextprotocol.io/quickstart/user

クロード・コード

Claude Code をインストールした後、次のコマンドを実行します。

claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -- npx -y @circleci/mcp-server-circleci

Claude Code で MCP サーバーを使用する方法の詳細については、以下のガイドを参照してください: https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp

VSコード

MCP サーバーを、settings.json のmcp -> serversの下に追加します。

"circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only } }

VS Code で MCP サーバーを使用する方法の詳細については、以下のガイドを参照してください: https://code.visualstudio.com/docs/copilot/chat/mcp-servers

ウィンドサーフィン

windsurf mcp_config.json に以下を追加します。

{ "mcpServers": { "circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only } } } }

Windsurf で MCP サーバーを使用する方法の詳細については、以下のガイドを参照してください: https://docs.windsurf.com/windsurf/mcp

特徴

サポートされているツール

  • get_build_failure_logsCircleCI ビルドから詳細な失敗ログを取得します。このツールは次の 2 つの方法で使用できます。
    1. CircleCI URL の使用:
    2. ローカル プロジェクト コンテキストの使用:
      • 以下を提供することで、ローカル ワークスペースから作業できます。
        • ワークスペースのルートパス
        • GitリモートURL
        • 支店名
      • 例: 「現在のブランチで最後に失敗したパイプラインを見つける」

    このツールは、次のようなフォーマットされたログを返します。

    • ジョブ名
    • ステップバイステップの実行の詳細
    • 失敗メッセージとコンテキスト

    これは特に次の場合に役立ちます:

    • 失敗したビルドのデバッグ
    • テストの失敗を分析する
    • 展開の問題の調査
    • IDEを離れずにビルドログに素早くアクセス
  • find_flaky_testsテスト実行履歴を分析し、CircleCIプロジェクト内の不安定なテストを特定します。この機能は、https: //circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detectionで説明されている不安定なテスト検出機能を活用します。このツールは次の 2 つの方法で使用できます。
    1. CircleCI プロジェクト URL の使用:
    2. ローカル プロジェクト コンテキストの使用:
      • 以下を提供することで、ローカル ワークスペースから作業できます。
        • ワークスペースのルートパス
        • GitリモートURL
      • 例: 「現在のプロジェクトで不安定なテストを見つける」

    このツールは、次のような不安定なテストに関する詳細な情報を返します。

    • テスト名とファイルの場所
    • 失敗メッセージとコンテキスト

    これは次のことに役立ちます:

    • テストスイート内の信頼性の低いテストを特定する
    • テストの失敗に関する詳細なコンテキストを取得する
    • テストの改善についてデータに基づいた意思決定を行う

発達

はじめる

  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 # Keep this running in one terminal
  2. 別のターミナルで、インスペクターを起動します。
    pnpm inspector
  3. 環境を構成します。
    • インスペクターUIの環境変数セクションにCIRCLECI_TOKENを追加します。
    • トークンにはCircleCIプロジェクトへの読み取りアクセスが必要です
    • オプションでCircleCIのベースURLを設定できます。デフォルトはhttps//circleci.comです。

テスト

  • テスト スイートを実行します。
    pnpm test
  • 開発中にウォッチモードでテストを実行します。
    pnpm test:watch

より詳しい貢献ガイドラインについては、 CONTRIBUTING.mdをご覧ください。

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

この MCP サーバーを使用すると、Cursor IDE または MCP クライアント対応エージェントを使用して、自然言語を使用して CircleCI で操作を実行できます。たとえば、自分のブランチで最近失敗したパイプラインを見つけてログを取得するなどです。

  1. Requirements
    1. Installation
      1. Cursor
      2. Claude Desktop
      3. Claude Code
      4. VS Code
      5. Windsurf
    2. Features
      1. Supported Tools
    3. Development
      1. Getting Started
      2. Development with MCP Inspector
      3. Testing
    ID: 65ardm1kp6