@codacy/codacy-mcp 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,31 +6,62 @@ MCP Server for the Codacy API, enabling access to repositories, files, quality,
|
|
|
6
6
|
|
|
7
7
|
## Tools
|
|
8
8
|
|
|
9
|
+
The following tools are available through the Codacy MCP Server:
|
|
10
|
+
|
|
11
|
+
### Repository Management
|
|
12
|
+
- `codacy_list_repositories`: List repositories in an organization with pagination support.
|
|
13
|
+
|
|
14
|
+
### Code Quality and Analysis
|
|
15
|
+
- `codacy_list_repository_issues`: Lists and filters code quality issues in a repository. This is the primary tool for investigating general code quality concerns (e.g. best practices, performance, complexity, style) but NOT security issues. For security-related issues, use the SRM items tool instead. Features include:
|
|
16
|
+
- Pagination support for handling large result sets
|
|
17
|
+
- Filtering by multiple criteria including severity, category, and language
|
|
18
|
+
- Author-based filtering for accountability
|
|
19
|
+
- Branch-specific analysis
|
|
20
|
+
- Pattern-based searching
|
|
21
|
+
|
|
22
|
+
Common use cases:
|
|
23
|
+
- Code quality audits
|
|
24
|
+
- Technical debt assessment
|
|
25
|
+
- Style guide compliance checks
|
|
26
|
+
- Performance issue investigation
|
|
27
|
+
- Complexity analysis
|
|
28
|
+
|
|
29
|
+
### File Management
|
|
30
|
+
- `codacy_list_files`: List files in a repository with pagination support.
|
|
31
|
+
- `codacy_get_file_issues`: Get the issue list for a file in a repository.
|
|
32
|
+
- `codacy_get_file_coverage`: Get coverage information for a file in the head commit of a repository branch.
|
|
33
|
+
|
|
34
|
+
### Security Analysis
|
|
35
|
+
- `codacy_list_srm_items`: Primary tool to list security items/issues/vulnerabilities/findings. Results are related to the organization security and risk management (SRM) dashboard on Codacy. Provides comprehensive security analysis including:
|
|
36
|
+
- SAST (Code scanning)
|
|
37
|
+
- Secrets (Secret scanning)
|
|
38
|
+
- SCA (Dependency scanning)
|
|
39
|
+
- IaC (Infrastructure-as-code scanning)
|
|
40
|
+
- CICD (CI/CD scanning)
|
|
41
|
+
- DAST (Dynamic Application Security Testing)
|
|
42
|
+
- PenTesting (Penetration testing)
|
|
43
|
+
|
|
44
|
+
Use this as the first tool when investigating security or compliance concerns.
|
|
45
|
+
|
|
46
|
+
### Pull Request Analysis
|
|
47
|
+
- `codacy_list_repository_pull_requests`: List pull requests from a repository that the user has access to. You can search this endpoint for either last-updated (default), impact or merged.
|
|
48
|
+
- `codacy_list_pull_request_issues`: Returns a list of issues found in a pull request. We can request either new or fixed issues.
|
|
49
|
+
- `codacy_get_repository_pull_request_files_coverage`: Get coverage information for all files in a pull request.
|
|
50
|
+
- `codacy_get_pull_request_git_diff`: Returns the human-readable Git diff of a pull request.
|
|
51
|
+
|
|
52
|
+
For detailed information about the parameters and filtering options available for each tool, please refer to the [Available Codacy API Actions](#available-codacy-api-actions) section below.
|
|
53
|
+
|
|
9
54
|
## Setup
|
|
10
55
|
|
|
11
56
|
### Personal API Access Token
|
|
12
57
|
|
|
13
58
|
Get your Codacy's Account API Token from your [Codacy Account](https://app.codacy.com/account/access-management).
|
|
14
59
|
|
|
15
|
-
### Usage
|
|
16
|
-
|
|
17
|
-
To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
|
|
60
|
+
### Usage
|
|
18
61
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
{
|
|
23
|
-
"mcpServers": {
|
|
24
|
-
"codacy": {
|
|
25
|
-
"command": "docker",
|
|
26
|
-
"args": ["run", "-i", "--rm", "-e", "CODACY_ACCOUNT_TOKEN", "mcp/codacy"],
|
|
27
|
-
"env": {
|
|
28
|
-
"CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
```
|
|
62
|
+
Depending on what are you connecting the MCP Server to, you can use the following methods:
|
|
63
|
+
- Cursor: edit the `.cursor/mcp.json` file to add the following
|
|
64
|
+
- Claude Desktop: edit the `claude_desktop_config.json` file to add the following
|
|
34
65
|
|
|
35
66
|
### NPX
|
|
36
67
|
|
|
@@ -50,7 +81,11 @@ To use this with Claude Desktop, add the following to your `claude_desktop_confi
|
|
|
50
81
|
|
|
51
82
|
### Node (when using NVM)
|
|
52
83
|
|
|
53
|
-
When using NVM, NPX won't work. You
|
|
84
|
+
When using NVM with Claude Desktop, NPX won't work. You should first install the MCP Server globally, and thenuse Node directly:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npm install -g @codacy/codacy-mcp
|
|
88
|
+
```
|
|
54
89
|
|
|
55
90
|
```json
|
|
56
91
|
{
|
|
@@ -71,15 +106,11 @@ When using NVM, NPX won't work. You can use Node directly:
|
|
|
71
106
|
Local:
|
|
72
107
|
|
|
73
108
|
```bash
|
|
109
|
+
npm install
|
|
110
|
+
npm run update-api
|
|
74
111
|
npm run build
|
|
75
112
|
```
|
|
76
113
|
|
|
77
|
-
Docker build:
|
|
78
|
-
|
|
79
|
-
```bash
|
|
80
|
-
docker build -t mcp/codacy -f src/codacy/Dockerfile .
|
|
81
|
-
```
|
|
82
|
-
|
|
83
114
|
## License
|
|
84
115
|
|
|
85
116
|
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
|