@codacy/codacy-mcp 0.6.13 → 0.6.15

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.
Files changed (2) hide show
  1. package/README.md +64 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,9 +1,32 @@
1
1
  # Codacy MCP Server
2
-
3
2
  [![Codacy Badge](https://app.codacy.com/project/badge/Grade/7be4b119dc1e420198f3495017b57c89)](https://app.codacy.com/gh/codacy/codacy-mcp-server/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
4
3
 
4
+
5
5
  MCP Server for the Codacy API, enabling access to repositories, files, quality, coverage, security and more.
6
6
 
7
+
8
+ ## Table of Contents
9
+ - [Features / Tools](#features--tools)
10
+ - [Repository Setup and Management](#repository-setup-and-management)
11
+ - [Organization and Repository Management](#organization-and-repository-management)
12
+ - [Code Quality and Analysis](#code-quality-and-analysis)
13
+ - [File Management and Analysis](#file-management-and-analysis)
14
+ - [Security Analysis](#security-analysis)
15
+ - [Pull Request Analysis](#pull-request-analysis)
16
+ - [Tool and Pattern Management](#tool-and-pattern-management)
17
+ - [CLI Analysis](#cli-analysis)
18
+ - [Setup](#setup)
19
+ - [Requirements](#requirements)
20
+ - [Personal API Access Token](#personal-api-access-token)
21
+ - [Install](#install)
22
+ - [Cursor, Windsurf, and others](#cursor-windsurf-and-others)
23
+ - [VS Code with Copilot](#vs-code-with-copilot)
24
+ - [Troubleshooting](#troubleshooting)
25
+ - [Contribute](#contribute)
26
+ - [Codacy-CLI Support](#codacy-cli-support)
27
+ - [License](#license)
28
+
29
+
7
30
  ## Features / Tools
8
31
 
9
32
  The following tools are available through the Codacy MCP Server:
@@ -101,15 +124,19 @@ Get your Codacy's Account API Token from your [Codacy Account](https://app.codac
101
124
 
102
125
  You'll need it later in the setup.
103
126
 
104
- ### Usage
127
+ ### Install
105
128
 
106
129
  In supported IDEs like VS Code, Cursor, and Windsurf, the easiest way to install Codacy's MCP Server is to do it from the Codacy extension. If you haven't yet, install the extension from within your IDE, or from any of the available marketplaces ([Microsoft](https://marketplace.visualstudio.com/items?itemName=codacy-app.codacy), [OpenVSX](https://open-vsx.org/extension/codacy-app/codacy)). From the extension panel, just click on Add Codacy MCP Server. Restart your IDE afterwards.
107
130
 
108
131
  Without the extension, you can still use and install the MCP Server:
109
132
 
110
- ### Cursor, Windsurf, and others
133
+ #### Cursor, Windsurf, and others
134
+
135
+ You can use the one-click install for Cursor:
111
136
 
112
- Depending on what you are connecting the MCP Server to, you can use the following methods:
137
+ [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=codacy&config=eyJjb21tYW5kIjoibnB4IC15IEBjb2RhY3kvY29kYWN5LW1jcEBsYXRlc3QiLCJlbnYiOnsiQ09EQUNZX0FDQ09VTlRfVE9LRU4iOiI8WW91ciBwZXJzb25hbCB0b2tlbj4ifX0%3D)
138
+
139
+ Otherwise, depending on what you are connecting the MCP Server to, you can use the following methods:
113
140
 
114
141
  - Cursor: edit the `.cursor/mcp.json` file to add the following
115
142
  - Windsurf: edit the `.codeium/windsurf/mcp_config.json` file to add the following
@@ -122,15 +149,21 @@ Depending on what you are connecting the MCP Server to, you can use the followin
122
149
  "command": "npx",
123
150
  "args": ["-y", "@codacy/codacy-mcp"],
124
151
  "env": {
125
- "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>",
126
- "CODACY_CLI_VERSION": "<VERSION>"
152
+ "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
127
153
  }
128
154
  }
129
155
  }
130
156
  }
131
157
  ```
132
158
 
133
- ### VS Code with Copilot
159
+
160
+ #### VS Code with Copilot
161
+
162
+ You can use the one-click install for VS Code:
163
+
164
+ [![Install with Codacy in VS Code](https://img.shields.io/badge/VS_Code-Install_Codacy_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=codacy&inputs=%5B%7B%22id%22%3A%22codacy_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Codacy%20Account%20Token%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40codacy%2Fcodacy-mcp%40latest%22%5D%2C%22env%22%3A%7B%22CODACY_ACCOUNT_TOKEN%22%3A%22%24%7Binput%3Acodacy_token%7D%22%7D%7D) [![Install with Codacy in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Codacy_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=codacy&inputs=%5B%7B%22id%22%3A%22codacy_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Codacy%20Account%20Token%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40codacy%2Fcodacy-mcp%40latest%22%5D%2C%22env%22%3A%7B%22CODACY_ACCOUNT_TOKEN%22%3A%22%24%7Binput%3Acodacy_token%7D%22%7D%7D&quality=insiders)
165
+
166
+ Otherwise, if you wish to set it up manually:
134
167
 
135
168
  1. For connecting the MCP Server to Copilot in VS Code, add the following to the global config of the IDE:
136
169
 
@@ -143,8 +176,7 @@ Depending on what you are connecting the MCP Server to, you can use the followin
143
176
  "command": "npx",
144
177
  "args": ["-y", "@codacy/codacy-mcp"],
145
178
  "env": {
146
- "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>",
147
- "CODACY_CLI_VERSION": "<VERSION>"
179
+ "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
148
180
  }
149
181
  }
150
182
  }
@@ -170,9 +202,9 @@ Don't forget to update the value of `CODACY_ACCOUNT_TOKEN` with your token.
170
202
 
171
203
  ![Copilot Agent with Codacy tools](docs/copilot_agent.png)
172
204
 
173
- ### Node Troubleshooting
205
+ ## Troubleshooting
174
206
 
175
- #### Claude Desktop
207
+ ### Claude Desktop and NVM
176
208
 
177
209
  When using NVM with Claude Desktop, NPX may not work. You should first install the MCP Server globally, and then use Node directly:
178
210
 
@@ -187,17 +219,16 @@ npm install -g @codacy/codacy-mcp
187
219
  "command": "/Users/yourusername/.nvm/versions/node/vXX.X.X/bin/node",
188
220
  "args": ["/path-to/codacy-mcp/dist/index.js"],
189
221
  "env": {
190
- "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>",
191
- "CODACY_CLI_VERSION": "<VERSION>"
222
+ "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
192
223
  }
193
224
  }
194
225
  }
195
226
  }
196
227
  ```
197
228
 
198
- ## Build
229
+ ## Contribute
199
230
 
200
- Local:
231
+ To work locally on the MCP Server code, run:
201
232
 
202
233
  ```bash
203
234
  npm install
@@ -205,9 +236,25 @@ npm run update-api
205
236
  npm run build
206
237
  ```
207
238
 
208
- ## Codacy-CLI Support (WIP)
239
+ Then you can test your local instance configuring the MCP Server as follows:
240
+
241
+ ```
242
+ "codacy": {
243
+ "command": "/path/to/bin/node",
244
+ "args": [
245
+ "/path/to/codacy-mcp-server/dist/index.js"
246
+ ],
247
+ "env": {
248
+ "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
249
+ }
250
+ }
251
+ ```
252
+
253
+ ## Codacy-CLI Support
254
+
255
+ In order to use the [Codacy-CLI](https://github.com/codacy/codacy-cli-v2), it needs to be installed. Whenever the MCP Server will receive a request to analyze, it will try to install the CLI and initialize it.
209
256
 
210
- In order to use the [Codacy-CLI](https://github.com/codacy/codacy-cli-v2), it needs to be installed. Note that the `CODACY_CLI_VERSION` variable is optional, in case you want to use a specific version of our CLI.
257
+ In case you want to use a specific version of our CLI, send a `CODACY_CLI_VERSION` env variable in the MCP Server configuration.
211
258
 
212
259
  ## License
213
260
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@codacy/codacy-mcp",
3
- "version": "0.6.13",
3
+ "version": "0.6.15",
4
4
  "description": "Codacy MCP server",
5
5
  "license": "MIT",
6
6
  "author": "Codacy",