MCP Server Codecov

🚀 Codecov用MCPサーバー

CodecovのMCP（Model Context Protocol）サーバーです。Codecovのカバレッジデータを照会するためのツールを提供します。codecov.ioとセルフホスト型のCodecovインスタンスの両方をサポートし、URLエンドポイントを設定可能です。

📦 npmで公開中: mcp-server-codecov

🚀 クイックスタート

2分以内で始めることができます。

1. CodecovのAPIトークンを取得する

CodecovアカウントからAPIトークン（アップロードトークンではない）を作成します。

1. codecov.io（またはセルフホストのURL）にアクセスします。
2. アバターをクリック → 設定 → アクセスタブをクリックします。
3. 「トークンを生成する」をクリックし、「MCP Server API Access」と名前を付けます。
4. トークンの値をコピーします。

2. 環境変数を設定する

シェルプロファイル（~/.zshrcまたは~/.bashrc）に追加します。

export CODECOV_TOKEN="your-api-token-here"

その後、source ~/.zshrcで再読み込みします。

3. MCPサーバーをインストールする

claude mcp add --transport stdio codecov \
  --env CODECOV_BASE_URL=https://codecov.io \
  --env CODECOV_TOKEN=${CODECOV_TOKEN} \
  -- npx -y mcp-server-codecov

4. インストールを確認する

claude mcp get codecov

期待される出力: codecov: mcp-server-codecov - ✓ Connected

以上で完了です！ これでClaude CodeでCodecovのツールを使用できます。以下の利用可能なツールを参照してください。

✨ 主な機能

• ファイルレベルのカバレッジ: 特定のファイルの詳細な行単位のカバレッジデータを取得します。
• コミットカバレッジ: 個々のコミットのカバレッジ統計を取得します。
• リポジトリカバレッジ: リポジトリの全体的なカバレッジ指標を取得します。
• URL設定可能: 任意のCodecovインスタンス（codecov.ioまたはセルフホスト）を指定できます。
• トークン認証: カバレッジデータにアクセスするためのAPIトークンをサポートします。

トークンの種類

重要: Codecovには2種類のトークンがあります。

• アップロードトークン: CI/CD中にカバレッジレポートをCodecovにプッシュするために使用されます。リポジトリの設定 → 一般ページで見つけることができます。
• APIトークン: APIを介してCodecovからカバレッジデータを読み取るために使用されます。Codecovの設定 → アクセスタブで作成されます。

このMCPサーバーにはAPIトークンが必要で、アップロードトークンではありません。

利用可能なツール

get_file_coverage

特定のファイルの行単位のカバレッジデータを取得します。

パラメーター:

• owner (必須): リポジトリの所有者（ユーザー名または組織）
• repo (必須): リポジトリ名
• file_path (必須): リポジトリ内のファイルのパス（例: 'src/index.ts'）
• ref (オプション): Git参照（ブランチ、タグ、またはコミットSHA）

例:

mainブランチのowner/repoのsrc/index.tsのカバレッジを取得する

get_commit_coverage

特定のコミットのカバレッジデータを取得します。

パラメーター:

• owner (必須): リポジトリの所有者
• repo (必須): リポジトリ名
• commit_sha (必須): コミットSHA

例:

owner/repoのコミットabc123のカバレッジを取得する

get_repo_coverage

リポジトリの全体的なカバレッジ統計を取得します。

パラメーター:

• owner (必須): リポジトリの所有者
• repo (必須): リポジトリ名
• branch (オプション): ブランチ名（デフォルトはリポジトリのデフォルトブランチ）

例:

mainブランチのowner/repoの全体的なカバレッジを取得する

検証とトラブルシューティング

一般的な問題

1. 401 Unauthorizedエラー

• トークンの種類を確認する: 設定 → アクセスから取得したAPIトークンを使用していることを確認してください。アップロードトークンではありません。
• トークンが有効で、リポジトリにアクセスできることを確認します。
• セルフホスト型のインスタンスの場合、正しいCODECOV_BASE_URLを使用していることを確認します。

2. 環境変数が展開されない

• 変数がシェルでエクスポートされていることを確認してください（~/.zshrcまたは~/.bashrcを確認）。
• 環境変数を設定した後、Claude Codeを再起動します。
• 変数が存在することを確認します: echo $CODECOV_TOKEN

3. 接続に失敗した

• Claude CodeまたはClaude Desktopを再起動します。
• 環境変数が正しく設定されていることを確認します: echo $CODECOV_TOKEN
• 設定を確認します: claude mcp get codecov

4. HTTPとHTTPS

CODECOV_BASE_URLには常にhttps://を使用し、http://は使用しないでください。

• 正しい: https://your-codecov-instance.com
• 誤った: http://your-codecov-instance.com

高度な設定

セルフホスト型のCodecov

セルフホスト型のCodecovインスタンスの場合は、インスタンスのURLを使用します。

claude mcp add --transport stdio codecov \
  --env CODECOV_BASE_URL=https://codecov.your-company.com \
  --env CODECOV_TOKEN=${CODECOV_TOKEN} \
  -- npx -y mcp-server-codecov

Claude Desktopの設定

Claude Desktopの設定ファイルに追加します。

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

{
  "mcpServers": {
    "codecov": {
      "command": "npx",
      "args": ["-y", "mcp-server-codecov"],
      "env": {
        "CODECOV_BASE_URL": "https://codecov.io",
        "CODECOV_TOKEN": "your-codecov-token-here"
      }
    }
  }
}

手動設定（Claude Code）

~/.claude.jsonに追加します。

{
  "mcpServers": {
    "codecov": {
      "command": "npx",
      "args": ["-y", "mcp-server-codecov"],
      "env": {
        "CODECOV_BASE_URL": "https://codecov.io",
        "CODECOV_TOKEN": "${CODECOV_TOKEN}"
      }
    }
  }
}

注意:

• ${VAR}構文を使用して環境変数の展開がサポートされています。
• ${CODECOV_TOKEN}のような変数はシェル環境から読み取られます。
• npxの-yフラグは、パッケージのインストールプロンプトを自動的に承認します。

npmからグローバルにインストールする

npm install -g mcp-server-codecov

利点:

• 単一コマンドでの簡単なインストール
• npm update -g mcp-server-codecovで自動更新
• 手動でのビルド手順が不要
• すべてのプロジェクトで使用可能

インストールを確認する:

npm list -g mcp-server-codecov
which mcp-server-codecov
npm view mcp-server-codecov version

開発用インストール（ソースから）

この方法は、プロジェクトに貢献する場合のみ使用してください。

git clone https://github.com/egulatee/mcp-server-codecov.git
cd mcp-server-codecov
npm install
npm run build

その後、ビルドされたパスで設定します。

Claude Code CLI:

claude mcp add --transport stdio codecov \
  --env CODECOV_BASE_URL=https://codecov.io \
  --env CODECOV_TOKEN=${CODECOV_TOKEN} \
  -- node /absolute/path/to/codecov-mcp/dist/index.js

手動（~/.claude.json）:

{
  "mcpServers": {
    "codecov": {
      "command": "node",
      "args": ["/absolute/path/to/codecov-mcp/dist/index.js"],
      "env": {
        "CODECOV_BASE_URL": "https://codecov.io",
        "CODECOV_TOKEN": "${CODECOV_TOKEN}"
      }
    }
  }
}

Claude Desktop:

{
  "mcpServers": {
    "codecov": {
      "command": "node",
      "args": ["/path/to/mcp-server-codecov/dist/index.js"],
      "env": {
        "CODECOV_BASE_URL": "https://codecov.io",
        "CODECOV_TOKEN": "your-codecov-token-here"
      }
    }
  }
}

テスト

このプロジェクトは、Vitestを使用した包括的な単体テストにより、97%以上のコードカバレッジを維持しています。

詳細なテストドキュメント（テストの実行方法、カバレッジ要件、CI統合、およびテストの作成方法を含む）については、TESTING.md を参照してください。

開発

# 依存関係をインストールする
npm install

# プロジェクトをビルドする
npm run build

# 開発用のウォッチモード
npm run watch

リリースプロセス

このプロジェクトは、GitHub Actionsを介した自動化されたリリースワークフローを使用しています。バージョンタグをプッシュすると、リリースが自動的にnpmに公開されます。

詳細なリリース手順（前提条件、リリースの作成、手動リリース、およびバージョン番号付けを含む）については、RELEASE.md を参照してください。

API互換性

このサーバーはCodecovのAPI v2を使用しています。APIエンドポイントは以下のパターンに従います。

• ファイルカバレッジ: /api/v2/gh/{owner}/repos/{repo}/file_report/{file_path}
• コミットカバレッジ: /api/v2/gh/{owner}/repos/{repo}/commits/{commit_sha}
• リポジトリカバレッジ: /api/v2/gh/{owner}/repos/{repo}

現在はGitHubリポジトリ（gh）をサポートしています。他のプロバイダー（GitLab、Bitbucket）のサポートは、APIパスを変更することで追加できます。

📄 ライセンス

MIT