CircleCI MCP Server

CircleCI MCP サーバー

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

これにより、Cursor IDE、Windsurf、Copilot、または MCP に対応した任意のクライアントを使い、自然言語で CircleCI に関する操作を実行できます。たとえば、次のような操作が可能です。

• Find the latest failed pipeline on my branch and get logs https://github.com/CircleCI-Public/mcp-server-circleci/wiki#circleci-mcp-server-with-cursor-ide

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

要件

• CircleCI Personal API Token - CircleCI から生成できます。詳細はこちら、またはこちらをクリックしてすぐにアクセスできます。

NPX でインストールする場合：

• pnpm パッケージマネージャー - 詳細はこちら
• Node.js >= v18.0.0

Docker でインストールする場合：

• Docker - 詳細はこちら

インストール

Cursor

ローカル MCP サーバーで NPX を使用する

以下を 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" // Optional - required for on-prem customers only
      }
    }
  }
}

ローカル MCP サーバーで Docker を使用する

以下を Cursor の MCP 設定に追加します。

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "CIRCLECI_TOKEN",
        "-e",
        "CIRCLECI_BASE_URL",
        "circleci:mcp-server-circleci"
      ],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token",
        "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only
      }
    }
  }
}

セルフマネージドのリモート MCP サーバーを使用する

以下を Cursor の MCP 設定に追加します。

{
  "inputs": [
    {
      "type": "promptString",
      "id": "circleci-token", 
      "description": "CircleCI API Token",
      "password": true
    }
  ],
  "servers": {
    "circleci-mcp-server-remote": {
      "url": "http://your-circleci-remote-mcp-server-endpoint:8080/sse"
    }
  }
}

VS Code

ローカル MCP サーバーで NPX を使用する

CircleCI MCP Server を VS Code にインストールするには、.vscode/mcp.json に次の内容を追加します。

{
  // 💡 Inputs are prompted on first server start, then stored securely by VS Code.
  "inputs": [
    {
      "type": "promptString",
      "id": "circleci-token",
      "description": "CircleCI API Token",
      "password": true
    },
    {
      "type": "promptString",
      "id": "circleci-base-url",
      "description": "CircleCI Base URL",
      "default": "https://circleci.com"
    }
  ],
  "servers": {
    // https://github.com/ppl-ai/modelcontextprotocol/
    "circleci-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@circleci/mcp-server-circleci"],
      "env": {
        "CIRCLECI_TOKEN": "${input:circleci-token}",
        "CIRCLECI_BASE_URL": "${input:circleci-base-url}"
      }
    }
  }
}

ローカル MCP サーバーで Docker を使用する

Docker を使用して CircleCI MCP Server を VS Code にインストールするには、.vscode/mcp.json に次の内容を追加します。

{
  // 💡 Inputs are prompted on first server start, then stored securely by VS Code.
  "inputs": [
    {
      "type": "promptString",
      "id": "circleci-token",
      "description": "CircleCI API Token",
      "password": true
    },
    {
      "type": "promptString",
      "id": "circleci-base-url",
      "description": "CircleCI Base URL",
      "default": "https://circleci.com"
    }
  ],
  "servers": {
    // https://github.com/ppl-ai/modelcontextprotocol/
    "circleci-mcp-server": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "CIRCLECI_TOKEN",
        "-e",
        "CIRCLECI_BASE_URL",
        "circleci:mcp-server-circleci"
      ],
      "env": {
        "CIRCLECI_TOKEN": "${input:circleci-token}",
        "CIRCLECI_BASE_URL": "${input:circleci-base-url}"
      }
    }
  }
}

セルフマネージドのリモート MCP サーバーを使用する

セルフマネージドのリモート MCP サーバーを使用して CircleCI MCP Server を VS Code にインストールするには、.vscode/mcp.json に次の内容を追加します。

{
  "servers": {
    "circleci-mcp-server-remote": {
      "type": "sse",
      "url": "http://your-circleci-remote-mcp-server-endpoint:8080/sse"
    }
  }
}

Claude Desktop

ローカル MCP サーバーで NPX を使用する

以下を 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
      }
    }
  }
}

このファイルの場所：

macOS：~/Library/Application Support/Claude/claude_desktop_config.json

Windows：%APPDATA%\Claude\claude_desktop_config.json

Claude Desktop のセットアップ

ローカル MCP サーバーで Docker を使用する

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

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "CIRCLECI_TOKEN",
        "-e",
        "CIRCLECI_BASE_URL",
        "circleci:mcp-server-circleci"
      ],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token",
        "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only
      }
    }
  }
}

このファイルを見つける、または作成するには、まず Claude Desktop の設定を開きます。次に、設定ペイン左側の「Developer」をクリックし、「Edit Config」をクリックします。

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

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json

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

セルフマネージドのリモート MCP サーバーを使用する

まずラッパースクリプトを作成します

'circleci-remote-mcp.sh' などのスクリプトファイルを作成します：

#!/bin/bash
export CIRCLECI_TOKEN="your-circleci-token"
npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8080/sse --allow-http 

実行可能にします：

chmod +x circleci-remote-mcp.sh

次に、以下を claude_desktop_config.json に追加します：

{
  "mcpServers": {
    "circleci-remote-mcp-server": {
      "command": "/full/path/to/circleci-remote-mcp.sh"
    }
  }
}

このファイルを見つける、または作成するには、まず Claude Desktop の設定を開きます。次に、設定ペインの左側のバーにある「Developer」をクリックし、「Edit Config」をクリックします。

次の場所に設定ファイルが作成されます：

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

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

Claude Code

ローカル MCP サーバーで NPX を使用する

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

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

ローカル MCP サーバーで Docker を使用する

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

claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -e CIRCLECI_BASE_URL=https://circleci.com -- docker run --rm -i -e CIRCLECI_TOKEN -e CIRCLECI_BASE_URL 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

セルフマネージドのリモート MCP サーバーを使用する

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

claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -- npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8080/sse --allow-http

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

Windsurf

ローカル MCP サーバーで NPX を使用する

以下を 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
      }
    }
  }
}

ローカル MCP サーバーで Docker を使用する

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

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "CIRCLECI_TOKEN",
        "-e",
        "CIRCLECI_BASE_URL",
        "circleci:mcp-server-circleci"
      ],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token",
        "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only
      }
    }
  }
}

セルフマネージドのリモート MCP サーバーを使用する

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

{
  "mcpServers": {
    "circleci": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "http://your-circleci-remote-mcp-server-endpoint:8080/sse",
        "--allow-http"
      ],
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

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

Smithery 経由でインストールする

Smithery 経由で CircleCI MCP Server を Claude Desktop に自動的にインストールするには：

npx -y @smithery/cli install @CircleCI-Public/mcp-server-circleci --client claude

Amazon Q Developer CLi

Amazon Q Developer の MCP クライアント設定は、mcp.json という名前のファイルに JSON 形式で保存されます。

Amazon Q Developer CLI は、次の 2 つのレベルの MCP 設定をサポートしています：

グローバル設定：~/.aws/amazonq/mcp.json - すべてのワークスペースに適用されます

ワークスペース設定：.amazonq/mcp.json - 現在のワークスペースにのみ適用されます

どちらのファイルも任意です。どちらも、片方のみ、または両方が存在する場合があります。両方のファイルが存在する場合、Amazon Q Developer は両方から MCP 設定を読み取り、内容を統合します。競合が発生した場合（つまり、グローバル設定に定義されているサーバーがワークスペース設定にも存在する場合）は、警告が表示され、ワークスペース設定のサーバーエントリのみが使用されます。

ローカル MCP サーバーで NPX を使用する

グローバル設定ファイル ~/.aws/amazonq/mcp.json を編集するか、現在のワークスペースに .amazonq/mcp.json を新規作成し、以下の内容を追加します：

{
  "mcpServers": {
    "circleci-local": {
      "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
      },
      "timeout": 60000
    }
  }
}

セルフマネージドのリモート MCP サーバーを使用する

まずラッパースクリプトを作成します

'circleci-remote-mcp.sh' などのスクリプトファイルを作成します：

#!/bin/bash
export CIRCLECI_TOKEN="your-circleci-token"
npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8080/sse --allow-http

実行可能にします：

chmod +x circleci-remote-mcp.sh

次に、追加します：

q mcp add --name circleci --command "/full/path/to/circleci-remote-mcp.sh"

IDE の Amazon Q Developer

ローカル MCP サーバーで NPX を使用する

グローバル設定ファイル ~/.aws/amazonq/mcp.json を編集するか、現在のワークスペースに .amazonq/mcp.json を新規作成し、以下の内容を追加します：

{
  "mcpServers": {
    "circleci-local": {
      "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
      },
      "timeout": 60000
    }
  }
}

セルフマネージドのリモート MCP サーバーを使用する

最初にラッパースクリプトを作成します

「circleci-remote-mcp.sh」のようなスクリプトファイルを作成します。

#!/bin/bash
npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8080/sse --allow-http

実行可能にします。

chmod +x circleci-remote-mcp.sh

次に、IDE の Q Developer に追加します。

MCP 設定 UI にアクセスします（https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/mcp-ide.html#mcp-ide-configuration-access-ui）。

プラス（+）記号を選択します。

スコープとして、グローバルまたはローカルを選択します。

グローバルスコープを選択した場合、MCP サーバーの設定は ~/.aws/amazonq/mcp.json に保存され、すべてのプロジェクトで利用できます。ローカルスコープを選択した場合、設定は現在のプロジェクト内の .amazonq/mcp.json に保存されます。

Name フィールドに、CircleCI リモート MCP サーバーの名前を入力します（例：circleci-remote-mcp）。

トランスポートプロトコル（stdio）を選択します。

Command フィールドに、MCP サーバーの初期化時に実行する、先ほど作成したシェルコマンドを入力します（例：/full/path/to/circleci-remote-mcp.sh）。

Save ボタンをクリックします。

機能

対応ツール

• get_build_failure_logs

  CircleCI のビルドから詳細な失敗ログを取得します。このツールは、次の 3 つの方法で使用できます。

  1. プロジェクトスラッグとブランチを使用する（推奨ワークフロー）：

     • まず、利用可能なプロジェクトを一覧表示します。
       • list_followed_projects ツールを使用してプロジェクトを取得します
       • 例：「CircleCI のプロジェクトを一覧表示して」
       • 次に、projectSlug が関連付けられているプロジェクトを選択します
       • 例：「my-project を使いましょう」
     • 次に、特定のブランチのビルド失敗ログを取得するよう依頼します。
       • 例：「main ブランチの my-project のビルド失敗を取得して」

  2. CircleCI の URL を使用する：

     • 失敗したジョブの URL またはパイプラインの URL を直接指定します
     • 例：「https://app.circleci.com/pipelines/github/org/repo/123 からログを取得して」

  3. ローカルプロジェクトのコンテキストを使用する：

     • ローカルワークスペースから、次の情報を指定して使用できます。
       • ワークスペースのルートパス
       • Git リモート URL
       • ブランチ名
     • 例：「現在のブランチで最新の失敗したパイプラインを見つけて」

  ツールは、次の内容を含む整形済みログを返します。

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

  特に次の用途に役立ちます。

  • 失敗したビルドのデバッグ
  • テスト失敗の分析
  • デプロイの問題の調査
  • IDE を離れずにビルドログへすばやくアクセス

• find_flaky_tests

  テスト実行履歴を分析し、CircleCI プロジェクト内の不安定なテストを特定します。次のページで説明されている、不安定なテストの検出機能を活用します：https://circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detection

  このツールは、次の 3 つの方法で使用できます。

  1. プロジェクトスラッグを使用する（推奨ワークフロー）：

     • まず、利用可能なプロジェクトを一覧表示します。
       • list_followed_projects ツールを使用してプロジェクトを取得します
       • 例：「CircleCI のプロジェクトを一覧表示して」
       • 次に、projectSlug が関連付けられているプロジェクトを選択します
       • 例：「my-project を使いましょう」
     • 次に、不安定なテストを取得するよう依頼します。
       • 例：「my-project の不安定なテストを取得して」

  2. CircleCI のプロジェクト URL を使用する：

     • CircleCI のプロジェクト URL を直接指定します
     • 例：「https://app.circleci.com/pipelines/github/org/repo で不安定なテストを見つけて」

  3. ローカルプロジェクトのコンテキストを使用する：

     • ローカルワークスペースから、次の情報を指定して使用できます。
       • ワークスペースのルートパス
       • Git リモート URL
     • 例：「現在のプロジェクトで不安定なテストを見つけて」

  このツールは、次の 2 つの方法で使用できます。

  1. テキスト出力モードを使用する（デフォルト）：
     • 不安定なテストとその詳細をテキスト形式で返します
  2. ファイル出力モードを使用する（FILE_OUTPUT_DIRECTORY 環境変数の設定が必要）：
     • 不安定なテストとその詳細を含むディレクトリを作成します

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

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

  これにより、次のことが可能になります。

  • テストスイート内の不安定なテストを特定します
  • テスト失敗に関する詳細なコンテキストを取得します
  • データに基づいてテスト改善の判断を行います

• get_latest_pipeline_status

  指定したブランチの最新パイプラインのステータスを取得します。このツールは、次の3つの方法で使用できます。

  1. プロジェクトスラッグとブランチを使用する方法（推奨ワークフロー）：

     • まず、利用可能なプロジェクトを一覧表示します。
       • list_followed_projects ツールを使用してプロジェクトを取得します
       • 例：「CircleCI のプロジェクトを一覧表示して」
       • 次に、projectSlug が関連付けられているプロジェクトを選択します
       • 例：「my-project を使いましょう」
     • 次に、特定のブランチの最新パイプラインのステータスを取得するよう依頼します。
       • 例：「main ブランチにある my-project の最新パイプラインのステータスを取得して」

  2. CircleCI プロジェクト URL を使用する方法：

     • CircleCI のプロジェクト URL を直接指定します
     • 例：「https://app.circleci.com/pipelines/github/org/repo の最新パイプラインのステータスを取得して」

  3. ローカルプロジェクトのコンテキストを使用する方法：

     • 次の情報を指定して、ローカルワークスペースから使用します。
       • ワークスペースのルートパス
       • Git リモート URL
       • ブランチ名
     • 例：「現在のプロジェクトの最新パイプラインのステータスを取得して」

  このツールは、最新パイプラインのステータスを整形して返します。

  • ワークフロー名と現在のステータス
  • 各ワークフローの所要時間
  • 作成および完了のタイムスタンプ
  • パイプライン全体の状態

  出力例：

  ---
  Workflow: build
  Status: success
  Duration: 5 minutes
  Created: 4/20/2025, 10:15:30 AM
  Stopped: 4/20/2025, 10:20:45 AM
  ---
  Workflow: test
  Status: running
  Duration: unknown
  Created: 4/20/2025, 10:21:00 AM
  Stopped: in progress
  

  特に、次の用途に便利です。

  • 最新パイプラインのステータスを確認する
  • 特定のブランチの最新パイプラインのステータスを取得する
  • IDE を離れずに最新パイプラインのステータスをすばやく確認する

• get_job_test_results

  CircleCI ジョブのテストメタデータを取得し、IDE を離れずにテスト結果を分析できます。このツールは、次の3つの方法で使用できます。

  1. プロジェクトスラッグとブランチを使用する方法（推奨ワークフロー）：

     • まず、利用可能なプロジェクトを一覧表示します。
       • list_followed_projects ツールを使用してプロジェクトを取得します
       • 例：「CircleCI のプロジェクトを一覧表示して」
       • 次に、projectSlug が関連付けられているプロジェクトを選択します
       • 例：「my-project を使いましょう」
     • 次に、特定のブランチのテスト結果を取得するよう依頼します。
       • 例：「main ブランチにある my-project のテスト結果を取得して」

  2. CircleCI URL を使用する方法：

     • 次のいずれかの形式で CircleCI URL を指定します。
       • ジョブ URL："https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def/jobs/789"
       • ワークフロー URL："https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def"
       • パイプライン URL："https://app.circleci.com/pipelines/github/org/repo/123"
     • 例：「https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def のテスト結果を取得して」

  3. ローカルプロジェクトのコンテキストを使用する方法：

     • 次の情報を指定して、ローカルワークスペースから使用します。
       • ワークスペースのルートパス
       • Git リモート URL
       • ブランチ名
     • 例：「main ブランチにある現在のプロジェクトのテスト結果を取得して」

  このツールは、テスト結果に関する詳細情報を返します。

  • すべてのテストの概要（合計、成功、失敗）
  • 失敗したテストの詳細情報。次の項目が含まれます。
    • テスト名とクラス
    • ファイルの場所
    • エラーメッセージ
    • 実行時間
  • 実行時間の情報を含む、成功したテストの一覧
  • テスト結果による絞り込み

  特に、次の用途に便利です。

  • CircleCI の Web UI を開かずにテスト失敗をすばやく分析する
  • テスト失敗の傾向を特定する
  • 最適化が必要な可能性のある遅いテストを見つける
  • プロジェクト全体のテストカバレッジを確認する
  • 不安定なテストのトラブルシューティングを行う

  注：このツールを使用するには、CircleCI の設定でテストメタデータが正しく構成されている必要があります。テストメタデータ収集の設定方法について詳しくは、次を参照してください。 https://circleci.com/docs/collect-test-data/

• config_helper CircleCI の設定タスクを、ガイダンスと検証によって支援します。このツールでは、次のことができます。

  1. CircleCI 設定を検証する：
     • .circleci/config.yml の構文エラーと意味上のエラーを確認します
     • 例：「CircleCI 設定を検証してください」

  このツールは次を提供します。

  • 詳細な検証結果
  • 設定に関する推奨事項

  これにより、次のことができます。

  • プッシュする前に設定エラーを発見する
  • CircleCI 設定のベストプラクティスを学ぶ
  • 設定の問題をトラブルシューティングする
  • CircleCI の機能を正しく実装する

• create_prompt_template

  機能要件に基づいて、AI 対応アプリケーション向けの構造化されたプロンプトテンプレートの生成を支援します。このツールでは、次のことができます。

  1. 機能要件を構造化されたプロンプトに変換する：
     • ユーザー要件を最適化されたプロンプトテンプレートに変換します
     • 例：「年齢とトピックに合わせて、寝る前に読む物語を生成するプロンプトテンプレートを作成してください」

  このツールは次を提供します。

  • 構造化されたプロンプトテンプレート
  • 必要な入力パラメーターを定義するコンテキストスキーマ

  これにより、次のことができます。

  • AI アプリケーション向けの効果的なプロンプトを作成する
  • 入力パラメーターを標準化し、一貫した結果を得る
  • 堅牢な AI 搭載機能を構築する

• recommend_prompt_template_tests

  プロンプトテンプレートが期待どおりの結果を生成することを確認するためのテストケースを生成します。このツールでは、次のことができます。

  1. プロンプトテンプレート用のテストケースを提供する：
     • プロンプトテンプレートとコンテキストスキーマに基づいて、多様なテストシナリオを作成します
     • 例：「寝る前に読む物語のプロンプトテンプレート用のテストを生成してください」

  このツールは次を提供します。

  • 推奨テストケースの配列
  • テンプレートの堅牢性をテストするためのさまざまなパラメーターの組み合わせ

  これにより、次のことができます。

  • プロンプトテンプレートの機能を検証する
  • 入力にかかわらず、一貫した AI の応答を確保する
  • エッジケースや潜在的な問題を特定する
  • AI アプリケーション全体の品質を向上させる

• list_followed_projects

  ユーザーが CircleCI でフォローしているすべてのプロジェクトを一覧表示します。このツールでは、次のことができます。

  1. プロジェクトを取得して表示する：
     • ユーザーがアクセスでき、フォローしているすべてのプロジェクトを表示します
     • 各エントリーのプロジェクト名と projectSlug を表示します
     • 例：「CircleCI のプロジェクトを一覧表示してください」

  このツールは、プロジェクトの整形済みリストを返します。出力例：

  Projects followed:
  1. my-project (projectSlug: gh/organization/my-project)
  2. another-project (projectSlug: gh/organization/another-project)
  

  特に、次の用途に便利です。

  • 利用できる CircleCI プロジェクトを特定する
  • 他の CircleCI ツールで必要となる projectSlug を取得する
  • 後続の操作を行うプロジェクトを選択する

  注：多くの他の CircleCI ツールでは、プロジェクト名ではなく projectSlug が必要です。プロジェクトを選択すると、その後のツール呼び出しで使用されます。

• run_pipeline

  パイプラインの実行を開始します。このツールは、次の 3 通りの方法で使用できます。

  1. プロジェクトスラッグとブランチを使用する（推奨ワークフロー）：

     • まず、利用可能なプロジェクトを一覧表示します。
       • list_followed_projects ツールを使用して、プロジェクトを取得します
       • 例：「CircleCI のプロジェクトを一覧表示してください」
       • 次に、projectSlug が関連付けられたプロジェクトを選択します
       • 例：「my-project を使いましょう」
     • 次に、特定のブランチでパイプラインを実行するよう依頼します。
       • 例：「main ブランチで my-project のパイプラインを実行してください」

  2. CircleCI の URL を使用する：

     • 次のいずれかの形式の CircleCI URL を指定します。
       • ジョブ URL：「https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def/jobs/789」
       • ワークフロー URL：「https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def」
       • パイプライン URL：「https://app.circleci.com/pipelines/github/org/repo/123」
       • ブランチ付きプロジェクト URL：「https://app.circleci.com/projects/github/org/repo?branch=main」
     • 例：「https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def のパイプラインを実行してください」

  3. ローカルプロジェクトのコンテキストを使用する：

     • 次の情報を指定して、ローカルのワークスペースから実行します。
       • ワークスペースのルートパス
       • Git リモート URL
       • ブランチ名
     • 例：「現在のプロジェクトの main ブランチでパイプラインを実行してください」 このツールは、パイプラインの実行状況を確認するためのリンクを返します。

  特に次のような場合に便利です。

  • CircleCI のウェブ UI にアクセスせずに、パイプラインをすばやく実行する
  • 特定のブランチからパイプラインを実行する

• rerun_workflow

  ワークフローを最初から、または失敗したジョブから再実行します。

  このツールは、新しく作成されたワークフローの ID と、そのワークフローの実行状況を確認するためのリンクを返します。

  特に次のような場合に便利です。

  • CircleCI のウェブ UI にアクセスせずに、ワークフローを最初から、または失敗したジョブからすばやく再実行する

• analyze_diff

  git の差分を Cursor のルールと照合し、ルール違反を特定します。

  このツールには、次の情報を指定できます。

  1. Git の差分内容：

     • ステージ済みの変更：git diff --cached
     • ステージされていない変更：git diff
     • すべての変更：git diff HEAD
     • 例：「ステージ済みの変更を Cursor のルールと照合して分析する」

  2. リポジトリのルール：

     • リポジトリのルートにある .cursorrules ファイルのルール
     • .cursor/rules ディレクトリのルール
     • 複数のルールファイルを --- 区切りで結合したもの
     • 例：「差分を TypeScript のコーディング規約と照合する」

  このツールは、次の情報を提供します。

  • 信頼度スコア付きの詳細な違反レポート
  • 各ルール違反の具体的な説明

  使用例：

  • 「ステージ済みの変更にルール違反がないか分析する」
  • 「ステージされていない変更をルールと照合する」

  特に次のような場合に便利です。

  • コミット前のコード品質チェック
  • チームのコーディング規約との一貫性の確保
  • コードレビュー前のルール違反の検出

  このツールは既存の Cursor ルール設定と連携し、コード品質についてすぐにフィードバックを提供するため、開発プロセスの早い段階で問題を検出できます。

開発

はじめに

1. リポジトリをクローンします。

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

2. 依存関係をインストールします。

   pnpm install
   

3. プロジェクトをビルドします。

   pnpm build
   

Docker コンテナのビルド

次のコマンドを使用して、Docker コンテナをローカルでビルドできます。

docker build -t circleci:mcp-server-circleci .

これにより、circleci:mcp-server-circleci というタグが付いた Docker イメージが作成され、任意の MCP クライアントで使用できます。

コンテナを実行するには、次のコマンドを実行します。

docker run --rm -i -e CIRCLECI_TOKEN=your-circleci-token -e CIRCLECI_BASE_URL=https://circleci.com circleci:mcp-server-circleci

MCP Inspector を使用した開発

MCP サーバーを効率よく反復開発するには、MCP Inspector を使用するのが最も簡単です。MCP Inspector の詳細については、https://modelcontextprotocol.io/docs/tools/inspector をご覧ください。

1. 開発サーバーを起動します。

   pnpm watch # Keep this running in one terminal
   

2. 別のターミナルで、Inspector を起動します。

   pnpm inspector
   

3. 環境を設定します。

   • Inspector の UI にある「Environment Variables」セクションに CIRCLECI_TOKEN を追加します
   • このトークンには、CircleCI プロジェクトへの読み取りアクセス権が必要です
   • 必要に応じて、CircleCI Base URL を設定できます。デフォルトは https//circleci.com です

テスト

• テストスイートを実行します。

  pnpm test
  

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

  pnpm test:watch
  

より詳しいコントリビューションガイドラインについては、CONTRIBUTING.md をご覧ください。