@codacy/codacy-mcp

中文文档
0.7.2发布于 2026/11/05MITES Module近 30 天下载 5696

Codacy MCP 服务器

中文使用文档
文档目录21 节
  1. 目录
  2. 特性/ 工具
  3. 仓库设置和管理
  4. 组织和仓库管理
  5. 代码质量和分析
  6. 文件管理和分析
  7. 安全分析
  8. 拉请求分析
  9. 工具和模式管理
  10. CLI 分析
  11. 设置
  12. 所需资源
  13. 个人 API 访问托肯
  14. 安装
  15. 解决问题
  16. 克洛德桌面和NVM
  17. 贡献
  18. 与检查员的测试
  19. 使用代理测试
  20. Codacy-CLI 支持系统
  21. 许可证

Codacy MCP 服务器

Codacy Badge

MCP 磁共振 Codacy API的服务器,可以访问寄存器,文件,质量,覆盖,安全等等.

目录

特性/ 工具

以下工具可通过Codacy MCP服务器提供:

仓库设置和管理

  • codacy_setup_repository: 如果 Codacy 中尚未出现, 则添加或跟踪仓库 。 这个工具确保存储器在Codacy注册,从而可以进行进一步的分析和管理.

组织和仓库管理

  • codacy_list_organizations: 列出有pagination支持的组织.
  • codacy_list_organization_repositories: 列出一个组织中具有页码支持的存储器.
  • codacy_get_repository_with_analysis: 获取数据库分析信息,包括级别、问题、重复、复杂性和覆盖面的衡量标准.

代码质量和分析

  • codacy_list_repository_issues:在寄存器中列出并过滤代码质量问题. 这是调查一般代码质量问题(例如最佳做法、性能、复杂性、风格)但非安全问题的主要工具。 对于与安全有关的问题,使用SRM项目工具。 特征包括:

    • 处理大型结果集的加固支持
    • 按多重标准过滤,包括严重程度、类别和语言
    • 基于作者的问责制过滤
    • 具体部门分析
    • 基于模式的搜索

    常用案例:

    • 守则质量审计
    • 技术债务评估
    • 样式指南检查
    • 业绩问题调查
    • 复杂性分析

文件管理和分析

  • codacy_list_files: 将文件列在一个有 pagination 支持的仓库中.
  • codacy_get_file_issues: 在寄存器中获取文件的发行列表 .
  • codacy_get_file_coverage: 在寄存器分支头执行中获取一个文件的覆盖信息.
  • codacy_get_file_clones:为寄存器中的文件获取复制克隆的列表(相同或非常相近的代码段).
  • codacy_get_file_with_analysis: 获取文件的详细分析信息,包括分级、问题、重复、复杂和覆盖的衡量标准.

安全分析

  • codacy_search_organization_srm_items: 列出一个组织的安全物品/问题/脆弱性/调查的主要工具。 结果涉及本组织在Codacy上的安全和风险管理仪表板.
  • codacy_search_repository_srm_items: 列出特定存放处的安全物品/问题/脆弱性/调查.

这两个工具都提供全面的安全分析,包括:

  • SAST(代码扫描)
  • 秘密( 秘密扫描)
  • SCA( 依赖性扫描)
  • IaC (基础设施- 编码扫描)
  • CID(CI/CD扫描)
  • DAST (动态应用程序安全测试)
  • 纸币测试(封装测试)

拉请求分析

  • codacy_list_repository_pull_requests: 列出用户可以访问的寄存器的拉动请求.
  • codacy_get_repository_pull_request:获取关于特定拉力请求的详细信息.
  • codacy_list_pull_request_issues: 返回牵引请求(新问题或固定问题)中发现的问题清单.
  • codacy_get_pull_request_files_coverage: 在拉请求中获取所有文件的 diff 覆盖信息 .
  • codacy_get_pull_request_git_diff: 返回牵引请求中人可读取的 Git diff .

工具和模式管理

  • 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 配置应用修正

设置

所需资源

确保您的机器安装了下列工具:

  • gi
  • 节点.js
    • 确保 npx 命令运行时没有问题.

对于本地分析,MCP服务器需要 科达西CLI 将安装。 如果无法使用, MCP 服务器将尝试为您安装它 。 codacy CLI v2运行于macOS,Linux,和Windows(只使用WSL)上.

个人 API 访问托肯

获取您的 Codacy 账户 API 从你的琴 编码账户。 。 。 .

你待会需要它.

安装

在被支持的IDE如VS Code, Cursor,和Windsurf中,最容易安装Codacy的MCP服务器的方法是从Codacy扩展来完成. 如果您还没有安装, 请从您的 IDE 或任何可用的市场安装扩展(微软, (中文(简体) ), 打开VSX) (中文(简体) ). 从扩展面板上点击 添加 Codacy MCP 服务器 。 之后重新启动您的 IDE .

没有扩展名,您仍可使用并安装 MCP 服务器 :

Cursor, Windsurf等软件

您可以为光标使用一击安装:

Install MCP Server

否则,取决于您正在连接什么 MCP 服务器,您可以使用以下方法:

  • 光标: 编辑 .cursor/mcp.json 要添加以下文件的文件
  • 风起云起:编辑 .codeium/windsurf/mcp_config.json 要添加以下文件的文件
  • 克劳德桌面:编辑 claude_desktop_config.json 要添加以下文件的文件
{
  "mcpServers": {
    "codacy": {
      "command": "npx",
      "args": ["-y", "@codacy/codacy-mcp"],
      "env": {
        "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

VS 代码与副驾驶

您可以使用 VS 代码的一击安装 :

Install with Codacy in VS Code Install with Codacy in VS Code Insiders

否则,如果你想手动设置:

  1. 关于在 VS 代码中连接 MCP 服务器到 Copilot, 在 IDE 全球配置中加入以下内容:
{
  "mcp": {
    "inputs": [],
    "servers": {
      "codacy": {
        "command": "npx",
        "args": ["-y", "@codacy/codacy-mcp"],
        "env": {
          "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
        }
      }
    }
  }
}

您可以在 :

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

或直接打开一般设置.json文件,根据您的OS,它应该位于:

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

别忘了更新它的价值 CODACY_ACCOUNT_TOKEN 用你的纪念品.

  1. 确保您启用代理模式 : vscode://stings/chat.agent. 已启用

  2. 打开副驾驶聊天并切换模式 Agent。您可以通过点击 Select tools 图标,该图标应列出所有可用的 Codacy 工具.

Copilot Agent with Codacy tools

解决问题

克洛德桌面和NVM

当使用克洛德桌面的NVM时,NPX可能无法工作. 您应该首先在全球安装 MCP 服务器, 然后直接使用节点 :

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

与检查员的测试

您可以使用检测工具测试 MCP 服务器 。 你可以设置一个 CODACY_ACCOUNT_TOKEN 环境变量或通过内线:

CODACY_ACCOUNT_TOKEN=your_token_here npm run inspect

这将建立项目 并启动 MCP检查员 与你的codacy标志.

使用代理测试

您可以测试您的本地实例配置 MCP 服务器如下 :

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

Codacy-CLI 支持系统

为了使用 科达西-CLI,需要安装。 当MCP服务器收到分析请求时,它将尝试安装CLI并初始化.

如果你想使用特定版本的CLI,请发送 CODACY_CLI_VERSION mCP服务器配置中的env变量.

许可证

这个MCP服务器根据麻省理工学院许可证获得许可. 这意味着您可以自由使用,修改并分发软件,但须遵守麻省理工学院许可证的条款和条件. 详情请参见项目仓库中的LICENSE文件.

版本与发布记录

@codacy/codacy-mcp 共发布 72 个版本,首次发布于 2025/03/26;过去 12 个月发布了 10 个版本。

版本发布日期距今
0.7.2latest2026/11/054 天前
0.7.12026/11/036 天前
0.7.02026/10/2218 天前
0.6.252026/09/221 个月前
0.6.242026/07/303 个月前
0.6.232026/07/283 个月前

其他发布通道:unstable → 0.0.5-fixpublishstep.4.0c4d44b。

关于 @codacy/codacy-mcp 的常见问题

@codacy/codacy-mcp 是什么?

Codacy MCP 服务器

如何安装 @codacy/codacy-mcp?

在项目目录运行 npm install @codacy/codacy-mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 codacy-mcp-server,可以用 npx codacy-mcp-server 直接运行。

@codacy/codacy-mcp 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/codacy__codacy-mcp 是否存在。

@codacy/codacy-mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@codacy/codacy-mcp 可以商用吗?

@codacy/codacy-mcp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@codacy/codacy-mcp 的下载量有多少?

根据 npm 官方下载统计,@codacy/codacy-mcp 在 2026/10/10 – 2026/11/08 这 30 天内被下载 5,696 次,日均约 190 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@codacy/codacy-mcp 还在维护吗?

最新版本 0.7.2 发布于 2026/11/05(4 天前);至今共发布 72 个版本,其中过去 12 个月发布了 10 个;首次发布于 2025/03/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。