Codacy MCP Server

🚀 Codacy 代碼管理平臺 MCP 服務器

Codacy 的代碼管理平臺（MCP）服務器為 Codacy API 提供服務，讓用戶能夠訪問倉庫、文件、查看代碼質量等。本文檔將詳細介紹該服務器的使用方法、相關工具及服務。

🚀 快速開始

Codacy 代碼管理平臺（MCP）服務器為開發者提供了強大的代碼管理和分析功能。通過以下步驟，你可以輕鬆配置並使用該服務器。

✨ 主要特性

組織和倉庫管理

• codacy_list_organizations：列出所有組織。
• codacy_list_repositories：列出指定組織下的所有倉庫。
• codacy_get_repository_info：獲取指定倉庫的信息。

代碼質量分析

• codacy_code_quality_analysis：提供代碼質量的詳細分析結果。
• codacy getCodeQualityAnalysis：返回指定倉庫的代碼質量數據。

文件和內容管理

• codacy_file_contents：獲取指定倉庫中的文件內容。
• codacy_get_blob_content：獲取指定 blob 的內容。
• codacy_search_code：在倉庫中搜索代碼片段。

安全分析

• codacy_security_analysis：提供倉庫的安全性分析結果，包括漏洞和依賴項問題。
• codacy_get_vulnerabilities：返回指定倉庫中的所有漏洞信息。

拉取請求分析

• codacy_pull_requests：獲取指定倉庫的所有拉取請求。
• codacy_get_pull_request_info：返回指定拉取請求的詳細信息，包括評論和審查狀態。

工具和模式管理

• codacy_list_tools：列出所有可用的工具。
• codacy_tool_execution：執行指定工具並對代碼進行分析。

CLI 分析（WIP）

• codacy_cli_support：支持 Codacy CLI 的集成，方便用戶通過命令行進行代碼分析。

📦 安裝指南

本地構建

1. 克隆倉庫：

   git clone https://github.com/codacy/codacy-mcp.git
   

2. 安裝依賴項：

   npm install
   

3. 更新 API 文檔：

   npm run update-api
   

4. 構建項目：

   npm run build
   

環境配置

• 環境變量：設置 CODACY_ACCOUNT_TOKEN 以啟用對 Codacy API 的訪問。

  export CODACY_ACCOUNT_TOKEN=<YOUR_TOKEN>
  

• NPM 配置：

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

💻 使用示例

基礎用法

在 VS Code 中使用

1. 打開用戶設置文件：

   • Windows: %APPDATA%\Code\User\settings.json
   • macOS: ~/Library/Application Support/Code/User/settings.json
   • Linux: ~/.config/Code/User/settings.json

2. 添加以下配置以啟用 Codacy 工具：

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

3. 啟用 Copilot 代理模式：

   • 打開命令面板，輸入 chat.agent.enabled 並啟用。

📚 詳細文檔

注意事項

⚠️ 重要提示

• NVM 用戶：如果使用 NVM，請確保 Node.js 和 npm 已正確配置。
• 故障排除：如遇問題，請檢查日誌輸出或參考官方文檔獲取幫助。

📄 許可證

此 MCP 服務器根據 MIT 許可證分發，允許用戶自由使用、修改和分發軟件。更多詳細信息請參閱項目倉庫中的 LICENSE 文件。

通過以上步驟，您可以輕鬆配置並使用 Codacy 的代碼管理平臺（MCP）服務器，以實現高效的代碼管理和分析。