JinDaGe - codacy-mcp-server MCP Details

article

README

🚀 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 的集成，方便用户通过命令行进行代码分析。

📦 安装指南

本地构建

克隆仓库：

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

安装依赖项：
```
npm install
```
更新 API 文档：
```
npm run update-api
```
构建项目：
```
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 中使用

打开用户设置文件：
- Windows: %APPDATA%\Code\User\settings.json
- macOS: ~/Library/Application Support/Code/User/settings.json
- Linux: ~/.config/Code/User/settings.json

添加以下配置以启用 Codacy 工具：

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

启用 Copilot 代理模式：
- 打开命令面板，输入 chat.agent.enabled 并启用。

📚 详细文档

注意事项

⚠️ 重要提示

NVM 用户：如果使用 NVM，请确保 Node.js 和 npm 已正确配置。

故障排除：如遇问题，请检查日志输出或参考官方文档获取帮助。

📄 许可证

此 MCP 服务器根据 MIT 许可证分发，允许用户自由使用、修改和分发软件。更多详细信息请参阅项目仓库中的 LICENSE 文件。

通过以上步骤，您可以轻松配置并使用 Codacy 的代码管理平台（MCP）服务器，以实现高效的代码管理和分析。

codacy-mcp-server