Codacy MCP Server

Codacy MCP サーバー

Codacy API 用の MCP サーバーです。リポジトリ、ファイル、品質、カバレッジ、セキュリティなどにアクセスできます。

目次

• 機能／ツール
  • リポジトリのセットアップと管理
  • 組織とリポジトリの管理
  • コードの品質と分析
  • ファイルの管理と分析
  • セキュリティ分析
  • プルリクエストの分析
  • ツールとパターンの管理
  • CLI 分析
• セットアップ
  • 要件
  • 個人用 API アクセストークン
  • インストール
    • Cursor、Windsurf など
    • Copilot を使用する VS Code
• トラブルシューティング
• 貢献
• Codacy-CLI のサポート
• ライセンス

機能／ツール

Codacy MCP サーバーでは、以下のツールを利用できます。

リポジトリのセットアップと管理

• codacy_setup_repository：Codacy に未登録のリポジトリを追加またはフォローします。このツールにより、リポジトリが Codacy に登録され、以降の分析や管理が可能になります。

組織とリポジトリの管理

• codacy_list_organizations：ページネーションに対応した組織の一覧を取得します。
• codacy_list_organization_repositories：ページネーションに対応した、組織内のリポジトリ一覧を取得します。
• codacy_get_repository_with_analysis：グレード、問題、重複、複雑度、カバレッジのメトリクスを含む、分析情報付きのリポジトリを取得します。

コードの品質と分析

• codacy_list_repository_issues：リポジトリ内のコード品質に関する問題を一覧表示し、絞り込みます。一般的なコード品質の懸念事項（ベストプラクティス、パフォーマンス、複雑度、スタイルなど）を調査する際の主要なツールですが、セキュリティの問題には使用しません。セキュリティ関連の問題には、代わりに SRM 項目ツールを使用してください。主な機能は次のとおりです。

  • 大量の結果を処理するためのページネーション対応
  • 重大度、カテゴリ、言語など、複数の条件による絞り込み
  • アカウンタビリティを明確にするための作成者による絞り込み
  • ブランチごとの分析
  • パターンによる検索

  主な用途：

  • コード品質監査
  • 技術的負債の評価
  • スタイルガイドへの準拠状況の確認
  • パフォーマンスの問題の調査
  • 複雑度の分析

ファイルの管理と分析

• codacy_list_files：ページネーションに対応したリポジトリ内のファイル一覧を取得します。
• codacy_get_file_issues：リポジトリ内のファイルに関する問題一覧を取得します。
• codacy_get_file_coverage：リポジトリブランチの HEAD コミットにおけるファイルのカバレッジ情報を取得します。
• codacy_get_file_clones：リポジトリ内のファイルについて、重複クローン（同一または非常によく似たコードセグメント）の一覧を取得します。
• codacy_get_file_with_analysis：グレード、問題、重複、複雑度、カバレッジのメトリクスを含む、ファイルの詳細な分析情報を取得します。

セキュリティ分析

• codacy_search_organization_srm_items：組織全体のセキュリティ項目／問題／脆弱性／検出結果を一覧表示するための主要なツールです。結果は Codacy の組織向けセキュリティ・リスク管理（SRM）ダッシュボードに関連しています。
• codacy_search_repository_srm_items：特定のリポジトリのセキュリティ項目／問題／脆弱性／検出結果を一覧表示します。

どちらのツールも、以下を含む包括的なセキュリティ分析を提供します。

• SAST（コードスキャン）
• Secrets（シークレットスキャン）
• SCA（依存関係スキャン）
• IaC（Infrastructure-as-Code スキャン）
• CICD（CI/CD スキャン）
• DAST（動的アプリケーションセキュリティテスト）
• PenTesting（ペネトレーションテスト）

プルリクエストの分析

• codacy_list_repository_pull_requests：ユーザーがアクセスできるリポジトリのプルリクエストを一覧表示します。
• codacy_get_repository_pull_request：特定のプルリクエストの詳細情報を取得します。
• codacy_list_pull_request_issues：プルリクエストで見つかった問題（新規または修正済み）の一覧を返します。
• codacy_get_pull_request_files_coverage：プルリクエスト内のすべてのファイルの差分カバレッジ情報を取得します。
• codacy_get_pull_request_git_diff：プルリクエストの人が読める形式の Git 差分を返します。

ツールとパターンの管理

• codacy_list_tools：Codacy で利用できるすべてのコード分析ツールを一覧表示します。
• codacy_list_repository_tools：リポジトリの分析ツール設定と利用可能なツールを取得します。
• codacy_get_pattern：特定のパターンの定義を取得します。
• codacy_list_repository_tool_patterns：リポジトリで利用できるツールのパターンを一覧表示します。
• codacy_get_issue：特定の問題の詳細情報を取得します。

CLI 分析

• codacy_cli_analyze：Codacy CLI を使用して、ローカルで品質分析を実行します。次の機能があります：
  • 特定のファイルまたはディレクトリ全体を分析する
  • 特定のツールまたは利用可能なすべてのツールを使用する
  • スケジュールされた分析を待たずに、すぐに結果を取得する
  • Codacy の設定に基づいて修正を適用する

セットアップ

必要条件

お使いのマシンに次のツールがインストールされていることを確認してください。

• git
• node.js
  • npx コマンドが問題なく実行できることを確認してください。

ローカル分析を行うには、MCP サーバーに Codacy CLI がインストールされている必要があります。利用できない場合、MCP サーバーがインストールを試みます。Codacy CLI v2 は macOS、Linux、Windows（WSL のみ）で動作します。

個人用 API アクセストークン

Codacy アカウントから Codacy のアカウント API トークンを取得してください。

このトークンは、後ほどセットアップで使用します。

インストール

VS Code、Cursor、Windsurf などの対応 IDE では、Codacy の拡張機能から MCP サーバーをインストールするのが最も簡単です。まだインストールしていない場合は、IDE 内または利用可能なマーケットプレイス（Microsoft、OpenVSX）から拡張機能をインストールしてください。拡張機能のパネルで「Codacy MCP Server を追加」をクリックし、その後 IDE を再起動してください。

拡張機能を使わなくても、MCP サーバーを利用してインストールできます。

Cursor、Windsurf など

Cursor では、ワンクリックインストールを利用できます。

それ以外の場合は、MCP サーバーの接続先に応じて、次の方法を使用できます。

• Cursor：.cursor/mcp.json ファイルを編集して、次の内容を追加します
• Windsurf：.codeium/windsurf/mcp_config.json ファイルを編集して、次の内容を追加します
• Claude Desktop：claude_desktop_config.json ファイルを編集して、次の内容を追加します

{
  "mcpServers": {
    "codacy": {
      "command": "npx",
      "args": ["-y", "@codacy/codacy-mcp"],
      "env": {
        "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

Copilot を使用した VS Code

VS Code では、ワンクリックインストールを利用できます。

それ以外に、手動で設定する場合は、次の手順に従ってください。

1. MCP サーバーを VS Code の Copilot に接続するには、IDE のグローバル設定に次の内容を追加します。

{
  "mcp": {
    "inputs": [],
    "servers": {
      "codacy": {
        "command": "npx",
        "args": ["-y", "@codacy/codacy-mcp"],
        "env": {
          "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
        }
      }
    }
  }
}

ユーザーの settings.json ファイルは、次の場所から開けます。

View > Command Palette > Preferences: Open User Settings (JSON)

または、OS に応じて次の場所にある一般的な settings.json ファイルを直接開いてください。

• macOS の場合：~/Library/Application Support/Code/User/settings.json
• Windows の場合：%APPDATA%\Code\User\settings.json
• Linux の場合：~/.config/Code/User/settings.json

CODACY_ACCOUNT_TOKEN の値を自分のトークンに更新するのを忘れないでください。

2. Agent モードが有効になっていることを確認します：vscode://settings/chat.agent.enabled

3. Copilot チャットを開き、モードを Agent に切り替えます。Select tools アイコンをクリックすると、MCP サーバーが正しく有効になっているか確認できます。利用可能な Codacy ツールがすべて表示されます。

トラブルシューティング

Claude Desktop と NVM

Claude Desktop で NVM を使用すると、NPX が動作しない場合があります。まず MCP サーバーをグローバルにインストールし、その後 Node を直接使用してください。

npm install -g @codacy/codacy-mcp

{
  "mcpServers": {
    "codacy": {
      "command": "/Users/yourusername/.nvm/versions/node/vXX.X.X/bin/node",
      "args": ["/path-to/codacy-mcp/dist/index.js"],
      "env": {
        "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

貢献

MCP サーバーのコードをローカルで作業するには、次を実行します。

npm install
npm run update-api
npm run build

Inspector を使用したテスト

Inspector ツールを使用して MCP サーバーをテストできます。CODACY_ACCOUNT_TOKEN 環境変数を設定するか、インラインで渡してください。

CODACY_ACCOUNT_TOKEN=your_token_here npm run inspect

これによりプロジェクトがビルドされ、Codacy トークンを指定して MCP Inspector が起動します。

エージェントを使用したテスト

次のように MCP サーバーを設定すると、ローカルインスタンスをテストできます。

"codacy": {
  "command": "/path/to/bin/node",
  "args": [
    "/path/to/codacy-mcp-server/dist/index.js"
  ],
  "env": {
    "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
  }
}

Codacy-CLI のサポート

Codacy-CLI を使用するには、インストールが必要です。MCP サーバーが分析リクエストを受け取ると、CLI のインストールと初期化を試みます。

CLI の特定のバージョンを使用する場合は、MCP サーバーの設定で CODACY_CLI_VERSION 環境変数を渡してください。

ライセンス

この MCP サーバーは MIT License の下でライセンスされています。つまり、MIT License の利用規約に従うことを条件に、このソフトウェアを自由に使用、変更、配布できます。詳しくは、プロジェクトリポジトリの LICENSE ファイルをご覧ください。