星战科技xingzhan.cloud
返回市场
代码卫士MCP服务器

代码卫士MCP服务器

作者：codacy55 星标更新：2025-10-01
安装使用来源：spider==github.com

项目介绍

Codacy MCP Server

Codacy 徽章

用于 Codacy API 的 MCP 服务器，提供对仓库、文件、质量、覆盖率、安全等方面的访问。

目录

功能 / 工具

以下工具可通过 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（持续集成/持续部署扫描）
  • 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: 获取特定问题的详细信息。

命令行分析

  • 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 令牌。

您将在后续设置中需要它。

安装

在支持的 IDE 如 VS Code、Cursor 和 Windsurf 中，安装 Codacy 的 MCP 服务器最简单的方法是从 Codacy 扩展中进行。如果您还没有安装，请从您的 IDE 或任何可用市场（Microsoft，OpenVSX）中安装扩展。从扩展面板中点击添加 Codacy MCP 服务器。之后重启您的 IDE。

没有扩展的情况下，您仍然可以使用和安装 MCP 服务器：

Cursor, Windsurf 和其他

您可以使用一键安装来安装 Cursor：

安装 MCP 服务器

否则，根据您连接的 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 with Copilot

您可以使用一键安装来安装 VS Code：

在 VS Code 中安装 Codacy 服务器 在 VS Code Insiders 中安装 Codacy 服务器

否则，如果您希望手动设置：

  1. 对于连接 MCP 服务器到 VS Code 中的 Copilot，向 IDE 的全局配置中添加以下内容：
{
  "mcp": {
    "inputs": [],
    "servers": {
      "codacy": {
        "command": "npx",
        "args": ["-y", "@codacy/codacy-mcp"],
        "env": {
          "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
        }
      }
    }
  }
}

您可以在以下位置打开用户设置.json 文件：

视图 > 命令面板 > 首选项：打开用户设置（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 的值为您的令牌。

  1. 确保启用了代理模式：vscode://settings/chat.agent.enabled

  2. 打开 Copilot 聊天并切换模式至 Agent。您可以通过点击 选择工具 图标来检查 MCP 服务器是否正确启用，该图标应该列出所有可用的 Codacy 工具。

Copilot Agent with Codacy tools

故障排除

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。

使用代理测试

您可以按照以下方式配置 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 许可证授权。这意味着您可以自由地使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。更多详情，请参阅项目存储库中的 LICENSE 文件。