Codacy MCP Server

🚀 Codacy Code Management Platform MCP Server

The Codacy Code Management Platform (MCP) Server provides services for the Codacy API, allowing users to access repositories, files, code quality, and more. This document details how to use the server and related tools and services.

🚀 Quick Start

The Codacy Code Management Platform (MCP) Server offers services for the Codacy API, enabling users to access repositories, files, code quality, and other features. This document elaborates on how to use the server, along with associated tools and services.

✨ Features

Organization and Repository Management

• codacy_list_organizations: Lists all organizations.
• codacy_list_repositories: Lists all repositories under a specified organization.
• codacy_get_repository_info: Retrieves information about a specified repository.

Code Quality Analysis

• codacy_code_quality_analysis: Provides detailed analysis results of code quality.
• codacy_getCodeQualityAnalysis: Returns code quality data for a specified repository.

File and Content Management

• codacy_file_contents: Retrieves the contents of a file in a specified repository.
• codacy_get_blob_content: Retrieves the content of a specified blob.
• codacy_search_code: Searches for code snippets in a repository.

Security Analysis

• codacy_security_analysis: Provides security analysis results for a repository, including vulnerabilities and dependency issues.
• codacy_get_vulnerabilities: Returns information about all vulnerabilities in a specified repository.

Pull Request Analysis

• codacy_pull_requests: Retrieves all pull requests for a specified repository.
• codacy_get_pull_request_info: Returns detailed information about a specified pull request, including comments and review status.

Tool and Pattern Management

• codacy_list_tools: Lists all available tools.
• codacy_tool_execution: Executes a specified tool and analyzes the code.

CLI Analysis (WIP)

• codacy_cli_support: Supports the integration of the Codacy CLI, allowing users to perform code analysis via the command line.

📦 Installation

Local Build

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Update the API documentation:

   npm run update-api
   

4. Build the project:

   npm run build
   

Environment Configuration

• Environment Variables: Set CODACY_ACCOUNT_TOKEN to enable access to the Codacy API.

  export CODACY_ACCOUNT_TOKEN=<YOUR_TOKEN>
  

• NPM Configuration:

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

💻 Usage Examples

Using in VS Code

1. Open the user settings file:

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

2. Add the following configuration to enable the Codacy tool:

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

3. Enable Copilot proxy mode:

   • Open the command palette, type chat.agent.enabled and enable it.

⚠️ Important Note

• NVM Users: If you are using NVM, ensure that Node.js and npm are properly configured.
• Troubleshooting: If you encounter issues, check the log output or refer to the official documentation for help.

📄 License

This MCP Server is distributed under the MIT License, which allows users to freely use, modify, and distribute the software. For more detailed information, please refer to the LICENSE file in the project repository.

By following the above steps, you can easily configure and use the Codacy Code Management Platform (MCP) Server for efficient code management and analysis.