使用说明
基本能力
产品定位
Codacy MCP 服务器是一个代码质量管理和安全分析平台,提供全面的代码质量检查、安全漏洞扫描、覆盖率分析等功能。
核心功能
-
代码仓库管理
- 代码仓库的添加、跟踪和管理
- 组织和仓库的列表查询
-
代码质量分析
- 代码问题检测(最佳实践、性能、复杂度、风格等)
- 技术债务评估
- 风格指南合规性检查
-
文件分析
- 文件列表查询
- 文件问题检测
- 文件覆盖率分析
- 代码重复检测
-
安全分析
- SAST(静态应用安全测试)
- 密钥扫描
- 依赖扫描
- 基础设施即代码扫描
- CI/CD扫描
- DAST(动态应用安全测试)
- 渗透测试
-
Pull Request 分析
- PR 列表查询
- PR 详细信息获取
- PR 问题检测
- PR 覆盖率分析
-
工具和模式管理
- 代码分析工具管理
- 模式定义获取
-
CLI 分析
- 本地代码质量分析
- 即时结果反馈
适用场景
- 代码质量审计
- 技术债务评估
- 安全漏洞扫描
- 代码覆盖率分析
- 代码风格合规检查
- Pull Request 质量检查
工具列表
codacy_setup_repository- 添加或跟踪代码仓库codacy_list_organizations- 列出组织codacy_list_organization_repositories- 列出组织中的仓库codacy_get_repository_with_analysis- 获取带分析信息的仓库codacy_list_repository_issues- 列出仓库中的代码问题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_search_repository_srm_items- 搜索仓库的安全风险项codacy_list_repository_pull_requests- 列出仓库的 Pull Requestcodacy_get_repository_pull_request- 获取 Pull Request 详细信息codacy_list_pull_request_issues- 列出 Pull Request 中的问题codacy_get_pull_request_files_coverage- 获取 Pull Request 文件的覆盖率codacy_get_pull_request_git_diff- 获取 Pull Request 的 Git diffcodacy_list_tools- 列出所有代码分析工具codacy_list_repository_tools- 列出仓库可用的工具codacy_get_pattern- 获取模式定义codacy_list_repository_tool_patterns- 列出仓库工具的模式codacy_get_issue- 获取问题详细信息codacy_cli_analyze- 本地 CLI 分析
使用教程
使用依赖
-
确保已安装以下工具:
# 安装 git # 根据操作系统使用相应包管理器 # 安装 Node.js # 确保 npx 命令可用 -
获取 Codacy 账户 API Token:
- 访问 Codacy 账户管理 获取
安装教程
-
通过 IDE 扩展安装(推荐):
- 在 VS Code、Cursor 或 Windsurf 中安装 Codacy 扩展
- 从扩展面板点击 "Add Codacy MCP Server"
- 重启 IDE
-
手动安装:
- 根据使用的 IDE 编辑相应配置文件(
.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>", "CODACY_CLI_VERSION": "<VERSION>" } } } } - 根据使用的 IDE 编辑相应配置文件(
-
VS Code 与 Copilot 集成:
- 编辑用户设置文件(settings.json)
- 添加上述配置
- 确保启用 Agent 模式
- 在 Copilot 聊天中切换到 Agent 模式
调试方式
- 检查 MCP 服务器是否正常运行
- 在 Copilot 聊天中点击 "Select tools" 图标,应列出所有可用的 Codacy 工具
- 对于 NVM 用户,可能需要全局安装 MCP 服务器:
npm install -g @codacy/codacy-mcp - 然后使用 Node 直接运行:
{ "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>", "CODACY_CLI_VERSION": "<VERSION>" } } } }
