Circleci Public MCP Server Circleci

🚀 サークルCI MCPサーバー

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

これにより、Cursor IDEや任意のMCPクライアントを使用して、自然言語でCircleCIとのやり取りを行うことができます。例えば：

• 自分のブランチ上で最新の失敗したパイプラインを見つけ、ログを取得する 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

🚀 クイックスタート

前提条件

• 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のビルドから詳細な失敗ログを取得します。このツールは2つの方法で使用できます：

  1. CircleCIのURLを使用する場合：

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

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

     • ローカルワークスペースで以下の情報を使用します：
       • ワークスペースのルートパス
       • GitのリモートURL
       • ブランチ名
     • 例：自分の現在のブランチで最新の失敗したパイプラインを見つける

  このツールは、以下を含む形式のログを返します：

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

  これは以下の目的に役立ちます：

  • ビルド失敗のデバッグ
  • テスト失敗の分析
  • デプロイ問題の調査
  • IDEを離れることなくビルドログにすぐアクセスする

🔧 開発に関する情報

開発の始め方

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のベースURLを設定できます。デフォルトは https://circleci.com です。

貢献について

貢献に関する詳細ガイドは CONTRIBUTING.md を参照してください。

📄 ライセンス

このプロジェクトは GitHubのライセンスバッジ で示されるライセンスの下で公開されています。詳細は こちら を参照してください。