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：获取代码仓库某个分支的最新提交中某个文件的覆盖率信息。
• 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（基础设施即代码扫描）
• 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 服务最简单的方式是通过 Codacy 扩展。如果您尚未安装，请在 IDE 中安装该扩展，或从可用的扩展市场安装（Microsoft、OpenVSX）。在扩展面板中，点击 Add 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>"
      }
    }
  }
}

VS Code 与 Copilot

你可以通过一键安装在 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)

或者直接打开通用的 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

使用 NVM 搭配 Claude Desktop 时，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。

使用 Agent 进行测试

你可以按如下方式配置 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 文件。