@codacy/codacy-mcp 0.5.4 → 0.5.6

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 +23 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,9 +2,7 @@
2
2
 
3
3
  MCP Server for the Codacy API, enabling access to repositories, files, quality, coverage, security and more.
4
4
 
5
- ### Features
6
-
7
- ## Tools
5
+ ## Features / Tools
8
6
 
9
7
  The following tools are available through the Codacy MCP Server:
10
8
 
@@ -65,10 +63,19 @@ The following tools are available through the Codacy MCP Server:
65
63
 
66
64
  ## Setup
67
65
 
66
+ ### Requirements
67
+
68
+ Ensure your machine has the following tools installed:
69
+ * git
70
+ * node.js
71
+ * ensure that the `npx` command runs without issues.
72
+
68
73
  ### Personal API Access Token
69
74
 
70
75
  Get your Codacy's Account API Token from your [Codacy Account](https://app.codacy.com/account/access-management).
71
76
 
77
+ You'll need it later in the setup.
78
+
72
79
  ### Usage
73
80
 
74
81
  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.
@@ -99,7 +106,7 @@ Depending on what you are connecting the MCP Server to, you can use the followin
99
106
 
100
107
  ### VS Code with Copilot
101
108
 
102
- For connecting the MCP Server to Copilot in VS Code, add the following to the global config of the IDE:
109
+ 1. For connecting the MCP Server to Copilot in VS Code, add the following to the global config of the IDE:
103
110
 
104
111
  ```json
105
112
  {
@@ -120,18 +127,28 @@ For connecting the MCP Server to Copilot in VS Code, add the following to the gl
120
127
  }
121
128
  }
122
129
  ```
130
+ You can open the user settings.json file in:
123
131
 
124
- You can find the global settings.json file in the following places, according to your OS:
132
+ `View > Command Palette > Preferences: Open User Settings (JSON)`
133
+
134
+ Or open the general settings.json file directly, which according to your OS should be located in:
125
135
 
126
136
  - for macOS: `~/Library/Application Support/Code/User/settings.json`
127
137
  - for Windows: `%APPDATA%\Code\User\settings.json`
128
138
  - for Linux: `~/.config/Code/User/settings.json`
129
139
 
130
- Make sure you have Agent mode enabled: [vscode://settings/chat.agent.enabled](vscode://settings/chat.agent.enabled)
140
+ Don't forget to update the value of `CODACY_ACCOUNT_TOKEN` with your token.
141
+
142
+ 2. Make sure you have Agent mode enabled: [vscode://settings/chat.agent.enabled](vscode://settings/chat.agent.enabled)
131
143
 
144
+ 3. Open the Copilot chat and switch the mode to `Agent`. You can check that the MCP server was enabled correctly by clicking on the `Select tools` icon, which should list all the available Codacy tools.
145
+
146
+ ![Copilot Agent with Codacy tools](docs/copilot_agent.png)
132
147
 
133
148
  ### Node Troubleshooting
134
149
 
150
+ #### Claude Desktop
151
+
135
152
  When using NVM with Claude Desktop, NPX may not work. You should first install the MCP Server globally, and then use Node directly:
136
153
 
137
154
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@codacy/codacy-mcp",
3
- "version": "0.5.4",
3
+ "version": "0.5.6",
4
4
  "description": "Codacy MCP server",
5
5
  "license": "MIT",
6
6
  "author": "Codacy",