API VEGA

Codacy MCP Server

MCP Server для Codacy API, обеспечивающий доступ к репозиториям, файлам, качеству кода, покрытию, безопасности и прочему.

Table of Contents

Repository Setup and Management

Requirements

Cursor, Windsurf, and others

Features / Tools

Ниже приведены инструменты, доступные через Codacy MCP Server:

Repository Setup and Management

  • codacy_setup_repository: Добавить или подписаться на репозиторий в Codacy, если он ещё не зарегистрирован. Этот инструмент обеспечивает регистрацию репозитория в Codacy, что позволяет дальнейший анализ и управление.

Organization and Repository Management

  • codacy_list_organizations: Получить список организаций с поддержкой пагинации.

  • codacy_list_organization_repositories: Получить список репозиториев в организации с поддержкой пагинации.

  • codacy_get_repository_with_analysis: Получить информацию о репозитории с анализом, включая метрики Grade, Issues, Duplication, Complexity и Coverage.

Code Quality and Analysis

  • codacy_list_repository_issues: Получает список и фильтрует проблемы качества кода в репозитории. Это основной инструмент для исследования общих вопросов качества кода (например, лучшие практики, производительность, сложность, стиль), но НЕ вопросы безопасности. Для вопросов безопасности используйте инструмент SRM items. Особенности включают:

    • Поддержка пагинации для обработки больших наборов результатов
    • Фильтрацию по нескольким критериям, включая severity, category и language
    • Фильтрацию по автору для учета ответственности
    • Анализ по веткам
    • Поиск по шаблонам

    Типичные варианты использования:

    • Аудиты качества кода
    • Оценка технического долга
    • Проверки соответствия стилю
    • Анализ проблем производительности
    • Анализ сложности

File Management and Analysis

  • codacy_list_files: Получить список файлов в репозитории с поддержкой пагинации.

  • codacy_get_file_issues: Получить список проблем для файла в репозитории.

  • codacy_get_file_coverage: Получить информацию о покрытии файла в HEAD-коммите ветки репозитория.

  • codacy_get_file_clones: Получить список дубликатов кода (идентичных или очень похожих фрагментов) для файла в репозитории.

  • codacy_get_file_with_analysis: Получить подробную информацию об анализе файла, включая метрики Grade, Issues, Duplication, Complexity и Coverage.

Security Analysis

  • codacy_search_organization_srm_items: Основной инструмент для перечисления элементов безопасности/уязвимостей/находок в рамках организации. Результаты связаны с панелью безопасности и управления рисками (SRM) организации на Codacy.

  • codacy_search_repository_srm_items: Перечень элементов SRM (безопасности/уязвимостей/находок) для конкретного репозитория.

Оба инструмента предоставляют всесторонний анализ безопасности, включая:

  • SAST (сканирование кода)
  • Secrets (сканирование секретов)
  • SCA (сканирование зависимостей)
  • IaC (сканирование инфраструктуры как кода)
  • CICD (сканирование CI/CD)
  • DAST (динамическое тестирование безопасности приложения)
  • PenTesting (пенетестинг)

Pull Request Analysis

  • codacy_list_repository_pull_requests: Получить список pull-запросов из репозитория, к которым у пользователя есть доступ.

  • codacy_get_repository_pull_request: Получить подробную информацию о конкретном pull-запросе.

  • codacy_list_pull_request_issues: Вернуть список проблем, найденных в pull-запросе (новые или исправленные).

  • codacy_get_pull_request_files_coverage: Получить информацию о покрытии различий (diff) для всех файлов в pull-запросе.

  • codacy_get_pull_request_git_diff: Вернуть читабельный Git diff pull-запроса.

Tool and Pattern Management

  • codacy_list_tools: Получить список всех инструментов анализа кода, доступных в Codacy.

  • codacy_list_repository_tools: Получить настройки инструментов анализа и доступные инструменты для репозитория.

  • codacy_get_pattern: Получить определение конкретного паттерна.

  • codacy_list_repository_tool_patterns: Получить перечень паттернов инструмента, доступных для репозитория.

  • codacy_get_issue: Получить подробную информацию о конкретной проблеме.

CLI Analysis

  • codacy_cli_analyze: Запуск локального анализа качества с использованием Codacy CLI. Возможности включают:

    • Анализ отдельных файлов или целых директорий
    • Использование конкретных инструментов или всех доступных инструментов
    • Получение немедленных результатов без ожидания запланированного анализа
    • Применение исправлений на основе конфигурации Codacy

Setup

Requirements

Убедитесь, что на вашей машине установлены следующие инструменты:

  • git
  • node.js

Убедитесь, что команда npx выполняется без проблем.

Для локального анализа MCP Server требует установленного Codacy CLI. Если он недоступен, MCP Server попытается установить его за вас. Codacy CLI v2 работает на macOS, Linux и Windows (только через WSL).

Personal API Access Token

Получите ваш API-токен учетной записи Codacy в вашей Codacy Account.

Его потребуется позже на этапе настройки.

Install

В поддерживаемых IDE, таких как VS Code, Cursor и Windsurf, самый простой способ установки Codacy MCP Server — через расширение Codacy. Если вы ещё не сделали этого, установите расширение внутри вашей IDE или в любом доступном маркетплейсе (Microsoft, OpenVSX). В панели расширения нажмите Add Codacy MCP Server. Перезапустите IDE.

Без расширения вы всё равно можете использовать и устанавливать MCP Server:

Cursor, Windsurf и прочие

Можно воспользоваться установкой в один клик для Cursor:

Иначе, в зависимости от того, к чему вы подключаете MCP Server, можно использовать следующие методы:

  • 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:

Иначе, если вы хотите настроить вручную:

- Для подключения MCP Server к Copilot в VS Code добавьте следующее в глобальную конфигурацию IDE:

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

Вы можете открыть файл user settings.json по пути:

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

Или открыть файл global 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 на ваш токен.

Убедитесь, что включен режим Agent: vscode://settings/chat.agent.enabled

Откройте Copilot чат и переключите режим на Agent. Вы сможете проверить, что MCP server был включён корректно, нажав на значок Choose tools/Select tools, который должен перечислить все доступные инструменты Codacy.

Troubleshooting

Claude Desktop и NVM

При использовании NVM с Claude Desktop NPX может не работать. Следует сначала установить MCP Server глобально, а затем использовать 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>" } } } }


## Contribute

Чтобы поработать локально над кодом MCP Server, выполните:

npm install npm run update-api npm run build


### Testing with Inspector

Вы можете протестировать MCP Server с помощью инструмента инспектора. Можно установить переменную окружения CODACY_ACCOUNT_TOKEN или передать токен напрямую:

CODACY_ACCOUNT_TOKEN=your_token_here npm run inspect


Это соберёт проект и запустит инспектор MCP с вашим токеном Codacy.

### Testing with an Agent

Вы можете протестировать локальный экземпляр, настроив MCP Server следующим образом:

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

Codacy-CLI Support

Чтобы использовать Codacy-CLI, его необходимо установить. Всякий раз, когда MCP Server получит запрос на анализ, он попытается установить CLI и инициализировать его.

Если вы хотите использовать конкретную версию нашего CLI, передайте переменную окружения CODACY_CLI_VERSION в конфигурацию MCP Server.

License

Этот MCP сервер лицензирован по MIT License. Это значит, что вы можете свободно использовать, модифицировать и распространять программное обеспечение, при условии соблюдения условий MIT License. Для получения более подробной информации ознакомьтесь с файлом LICENSE в репозитории проекта.