@codesherlock/codesherlock-beta-mcp-server 0.0.1 → 0.0.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 +300 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
# CodeSherlock MCP Server - Setup & Usage Guide
|
|
2
2
|
|
|
3
|
+
> **⚠️ Beta Version Notice**
|
|
4
|
+
> This is a beta release of the CodeSherlock MCP Server. Features may change, and some functionality may be experimental. We welcome your feedback to help us improve!
|
|
5
|
+
|
|
3
6
|
**Key Features:**
|
|
4
7
|
- Analyze uncommitted changes (staged and unstaged files)
|
|
5
8
|
- Analyze committed changes (from your latest commit)
|
|
@@ -11,9 +14,9 @@
|
|
|
11
14
|
## Prerequisites
|
|
12
15
|
|
|
13
16
|
Before you begin, ensure you have:
|
|
14
|
-
- Node.js (version
|
|
17
|
+
- Node.js (version 18.0.0 or higher) and npm installed on your system
|
|
15
18
|
- A Git repository with code you want to analyze
|
|
16
|
-
- An AI coding assistant that supports MCP (e.g., Claude
|
|
19
|
+
- An AI coding assistant that supports MCP (e.g., Claude Code, Cursor, VS Code, Cline, or similar)
|
|
17
20
|
|
|
18
21
|
The CodeSherlock MCP Server is available on the npm registry and can be used directly with `npx`.
|
|
19
22
|
|
|
@@ -41,38 +44,304 @@ CodeSherlock requires an API key to analyze your code. This API Key is used to a
|
|
|
41
44
|
|
|
42
45
|
## Step 2: Configure Your AI Assistant
|
|
43
46
|
|
|
44
|
-
You need to add the CodeSherlock MCP Server configuration to your AI assistant's settings.
|
|
47
|
+
You need to add the CodeSherlock MCP Server configuration to your AI assistant's settings. Follow the instructions for your preferred IDE/assistant below.
|
|
48
|
+
|
|
49
|
+
**Quick Links:**
|
|
50
|
+
- [Cursor](#cursor)
|
|
51
|
+
- [Windsurf](#windsurf)
|
|
52
|
+
- [Claude Code](#claude-code)
|
|
53
|
+
- [VS Code](#vs-code)
|
|
54
|
+
- [IntelliJ IDEA](#intellij-idea)
|
|
55
|
+
- [Cline](#cline)
|
|
45
56
|
|
|
46
|
-
|
|
47
|
-
- [Cursor](https://cursor.com/docs/context/mcp#using-mcpjson)
|
|
48
|
-
- [VS Code / GitHub Copilot](https://code.visualstudio.com/docs/copilot/customization/mcp-servers)
|
|
57
|
+
---
|
|
49
58
|
|
|
50
|
-
|
|
59
|
+
### Cursor
|
|
51
60
|
|
|
52
|
-
|
|
53
|
-
- **Command**: `npx`
|
|
54
|
-
- **Args**: `[-y, codesherlock-mcp-server]`
|
|
55
|
-
- **Server Name**: `codesherlock`
|
|
61
|
+
#### Steps to Configure
|
|
56
62
|
|
|
57
|
-
|
|
63
|
+
1. Click the **Settings** (gear icon) on the top right corner
|
|
64
|
+
2. Settings panel opens as a new tab in the center of the screen
|
|
65
|
+
3. In the settings sidebar, navigate to **Tools & MCP** section
|
|
66
|
+
4. Click on **New MCP Server** button
|
|
67
|
+
5. This opens the `mcp.json` config file
|
|
68
|
+
6. Add the configuration below and save
|
|
69
|
+
7. Restart Cursor
|
|
70
|
+
|
|
71
|
+
#### Configuration
|
|
58
72
|
|
|
59
73
|
```json
|
|
60
74
|
{
|
|
61
75
|
"mcpServers": {
|
|
62
76
|
"codesherlock": {
|
|
63
|
-
"name": "CodeSherlock
|
|
77
|
+
"name": "CodeSherlock MCP Server (Beta)",
|
|
64
78
|
"description": "CodeSherlock delivers deep code analysis and exposes MCP tools for commit analysis and uncommit analysis.",
|
|
65
79
|
"command": "npx",
|
|
66
|
-
"args": [
|
|
80
|
+
"args": [
|
|
81
|
+
"-y",
|
|
82
|
+
"codesherlock-mcp-server"
|
|
83
|
+
],
|
|
84
|
+
"env": {
|
|
85
|
+
"MCP_API_KEY": "your-api-key-here"
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
#### Config File Location
|
|
93
|
+
|
|
94
|
+
| OS | Path |
|
|
95
|
+
|----|------|
|
|
96
|
+
| **Windows** | `C:\Users\<Username>\.cursor\mcp.json` |
|
|
97
|
+
| **macOS** | `~/.cursor/mcp.json` |
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
### Windsurf
|
|
102
|
+
|
|
103
|
+
#### Steps to Configure
|
|
104
|
+
|
|
105
|
+
1. Click on the **Settings** (gear icon) on the top right corner and select **Windsurf Settings** (or press `Ctrl+,`)
|
|
106
|
+
2. In the settings search box, type **mcp**
|
|
107
|
+
3. Find the **MCP Servers** section
|
|
108
|
+
4. Click on **Open MCP Marketplace**
|
|
109
|
+
5. In the MCP Marketplace, click the **Settings** (gear icon) to add a custom server
|
|
110
|
+
6. This opens the `mcp_config.json` config file
|
|
111
|
+
7. Add the configuration below and save
|
|
112
|
+
8. Restart Windsurf
|
|
113
|
+
|
|
114
|
+
#### Configuration
|
|
115
|
+
|
|
116
|
+
```json
|
|
117
|
+
{
|
|
118
|
+
"mcpServers": {
|
|
119
|
+
"codesherlock": {
|
|
120
|
+
"name": "CodeSherlock MCP Server (Beta)",
|
|
121
|
+
"description": "CodeSherlock delivers deep code analysis and exposes MCP tools for commit analysis and uncommit analysis.",
|
|
122
|
+
"command": "npx",
|
|
123
|
+
"args": [
|
|
124
|
+
"-y",
|
|
125
|
+
"codesherlock-mcp-server"
|
|
126
|
+
],
|
|
127
|
+
"env": {
|
|
128
|
+
"MCP_API_KEY": "your-api-key-here"
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
#### Config File Location
|
|
136
|
+
|
|
137
|
+
| OS | Path |
|
|
138
|
+
|----|------|
|
|
139
|
+
| **Windows** | `C:\Users\<Username>\.codeium\windsurf\mcp_config.json` |
|
|
140
|
+
| **macOS** | `~/.codeium/windsurf/mcp_config.json` |
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
### Claude Code
|
|
145
|
+
|
|
146
|
+
#### Steps to Configure
|
|
147
|
+
|
|
148
|
+
Run the following command in your terminal:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
claude mcp add codesherlock -e MCP_API_KEY=your-api-key-here -- npx -y codesherlock-mcp-server
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**Other useful commands:**
|
|
155
|
+
```bash
|
|
156
|
+
claude mcp list # List all configured servers
|
|
157
|
+
claude mcp remove codesherlock # Remove a server
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
#### Configuration
|
|
161
|
+
|
|
162
|
+
**Manually add to config file (optional):**
|
|
163
|
+
```json
|
|
164
|
+
{
|
|
165
|
+
"mcpServers": {
|
|
166
|
+
"codesherlock": {
|
|
167
|
+
"command": "npx",
|
|
168
|
+
"args": [
|
|
169
|
+
"-y",
|
|
170
|
+
"codesherlock-mcp-server"
|
|
171
|
+
],
|
|
67
172
|
"env": {
|
|
68
|
-
"
|
|
173
|
+
"MCP_API_KEY": "your-api-key-here"
|
|
69
174
|
}
|
|
70
175
|
}
|
|
71
176
|
}
|
|
72
177
|
}
|
|
73
178
|
```
|
|
74
179
|
|
|
75
|
-
|
|
180
|
+
#### Config File Location
|
|
181
|
+
|
|
182
|
+
| OS | Path |
|
|
183
|
+
|----|------|
|
|
184
|
+
| **Windows** | `%APPDATA%\Claude\claude_desktop_config.json` |
|
|
185
|
+
| **macOS** | `~/.claude/claude_desktop_config.json` |
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
### VS Code
|
|
190
|
+
|
|
191
|
+
#### Steps to Configure
|
|
192
|
+
|
|
193
|
+
1. Press `Ctrl+Shift+P` (Windows) or `Cmd+Shift+P` (macOS) to open Command Palette
|
|
194
|
+
2. Type **MCP: Open User Configuration**
|
|
195
|
+
3. This opens the `mcp.json` config file
|
|
196
|
+
4. Add the configuration below and save
|
|
197
|
+
5. Restart VS Code
|
|
198
|
+
|
|
199
|
+
#### Configuration
|
|
200
|
+
|
|
201
|
+
```json
|
|
202
|
+
{
|
|
203
|
+
"mcpServers": {
|
|
204
|
+
"codesherlock": {
|
|
205
|
+
"name": "CodeSherlock MCP Server (Beta)",
|
|
206
|
+
"description": "CodeSherlock delivers deep code analysis and exposes MCP tools for commit analysis and uncommit analysis.",
|
|
207
|
+
"command": "npx",
|
|
208
|
+
"args": [
|
|
209
|
+
"-y",
|
|
210
|
+
"codesherlock-mcp-server"
|
|
211
|
+
],
|
|
212
|
+
"env": {
|
|
213
|
+
"MCP_API_KEY": "your-api-key-here"
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
#### Config File Location
|
|
221
|
+
|
|
222
|
+
| OS | Path |
|
|
223
|
+
|----|------|
|
|
224
|
+
| **Windows** | `C:\Users\<Username>\AppData\Roaming\Code\User\mcp.json` |
|
|
225
|
+
| **macOS** | `~/Library/Application Support/Code/User/mcp.json` |
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
229
|
+
### IntelliJ IDEA
|
|
230
|
+
|
|
231
|
+
#### Steps to Configure
|
|
232
|
+
|
|
233
|
+
**Method 1: Using JetBrains AI Assistant**
|
|
234
|
+
|
|
235
|
+
*Requires JetBrains AI Assistant plugin installed*
|
|
236
|
+
|
|
237
|
+
1. Click on the **Settings** (gear icon)
|
|
238
|
+
2. Navigate to **Tools** → **AI Assistant** → **MCP**
|
|
239
|
+
3. Add the configuration below and save
|
|
240
|
+
4. Restart IntelliJ IDEA
|
|
241
|
+
|
|
242
|
+
**Method 2: Using GitHub Copilot**
|
|
243
|
+
|
|
244
|
+
*Requires GitHub Copilot plugin installed*
|
|
245
|
+
|
|
246
|
+
1. Click on the **Settings** (gear icon)
|
|
247
|
+
2. Navigate to **Tools** → **GitHub Copilot** → **MCP**
|
|
248
|
+
3. Add the configuration below and save
|
|
249
|
+
4. Restart IntelliJ IDEA
|
|
250
|
+
|
|
251
|
+
#### Configuration
|
|
252
|
+
|
|
253
|
+
**For JetBrains AI Assistant:**
|
|
254
|
+
```json
|
|
255
|
+
{
|
|
256
|
+
"mcpServers": {
|
|
257
|
+
"codesherlock": {
|
|
258
|
+
"name": "CodeSherlock MCP Server (Beta)",
|
|
259
|
+
"description": "CodeSherlock delivers deep code analysis and exposes MCP tools for commit analysis and uncommit analysis.",
|
|
260
|
+
"command": "C:\\Program Files\\nodejs\\npx.cmd",
|
|
261
|
+
"args": [
|
|
262
|
+
"-y",
|
|
263
|
+
"codesherlock-mcp-server"
|
|
264
|
+
],
|
|
265
|
+
"env": {
|
|
266
|
+
"MCP_API_KEY": "your-api-key-here"
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
**For GitHub Copilot:**
|
|
274
|
+
```json
|
|
275
|
+
{
|
|
276
|
+
"servers": {
|
|
277
|
+
"codesherlock": {
|
|
278
|
+
"name": "CodeSherlock MCP Server (Beta)",
|
|
279
|
+
"description": "CodeSherlock delivers deep code analysis and exposes MCP tools for commit analysis and uncommit analysis.",
|
|
280
|
+
"command": "npx",
|
|
281
|
+
"args": [
|
|
282
|
+
"-y",
|
|
283
|
+
"codesherlock-mcp-server"
|
|
284
|
+
],
|
|
285
|
+
"env": {
|
|
286
|
+
"MCP_API_KEY": "your-api-key-here"
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
#### Config File Location
|
|
294
|
+
|
|
295
|
+
**GitHub Copilot:**
|
|
296
|
+
|
|
297
|
+
| OS | Path |
|
|
298
|
+
|----|------|
|
|
299
|
+
| **Windows** | `C:\Users\<Username>\AppData\Local\github-copilot\intellij\mcp.json` |
|
|
300
|
+
| **macOS** | `~/Library/Application Support/github-copilot/intellij/mcp.json` |
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
### Cline
|
|
305
|
+
|
|
306
|
+
*Cline is a VS Code extension. Install it from the VS Code marketplace or other supported IDEs.*
|
|
307
|
+
|
|
308
|
+
#### Steps to Configure
|
|
309
|
+
|
|
310
|
+
1. Open Cline panel in VS Code
|
|
311
|
+
2. Click on **Manage MCP Servers**
|
|
312
|
+
3. Click on the **Settings** (gear icon)
|
|
313
|
+
4. Click on **Configure MCP Servers** button
|
|
314
|
+
5. This opens the `cline_mcp_settings.json` config file
|
|
315
|
+
6. Add the configuration below and save
|
|
316
|
+
7. Restart VS Code
|
|
317
|
+
|
|
318
|
+
#### Configuration
|
|
319
|
+
|
|
320
|
+
```json
|
|
321
|
+
{
|
|
322
|
+
"mcpServers": {
|
|
323
|
+
"codesherlock": {
|
|
324
|
+
"name": "CodeSherlock MCP Server (Beta)",
|
|
325
|
+
"description": "CodeSherlock delivers deep code analysis and exposes MCP tools for commit analysis and uncommit analysis.",
|
|
326
|
+
"command": "npx",
|
|
327
|
+
"args": [
|
|
328
|
+
"-y",
|
|
329
|
+
"codesherlock-mcp-server"
|
|
330
|
+
],
|
|
331
|
+
"env": {
|
|
332
|
+
"MCP_API_KEY": "your-api-key-here"
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
#### Config File Location
|
|
340
|
+
|
|
341
|
+
| OS | Path |
|
|
342
|
+
|----|------|
|
|
343
|
+
| **Windows** | `C:\Users\<Username>\AppData\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json` |
|
|
344
|
+
| **macOS** | `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json` |
|
|
76
345
|
|
|
77
346
|
---
|
|
78
347
|
|
|
@@ -86,7 +355,7 @@ CodeSherlock supports three analysis factors:
|
|
|
86
355
|
|
|
87
356
|
| Factor | Description |
|
|
88
357
|
|--------|-------------|
|
|
89
|
-
| **power analysis** | A
|
|
358
|
+
| **power analysis** | A full-spectrum scan that covers the most essential and critical issues |
|
|
90
359
|
| **owasp** | Security analysis based on OWASP Top 10 vulnerabilities |
|
|
91
360
|
| **cwe** | Analyzes code against Common Weakness Enumeration (CWE) framework |
|
|
92
361
|
|
|
@@ -107,9 +376,11 @@ Here are practical examples of how to prompt your AI assistant to perform code a
|
|
|
107
376
|
```
|
|
108
377
|
"Analyze my latest commit for OWASP vulnerabilities using CodeSherlock"
|
|
109
378
|
```
|
|
379
|
+
|
|
110
380
|
```
|
|
111
381
|
"Check the last commit in my current repo for CWE issues with CodeSherlock"
|
|
112
382
|
```
|
|
383
|
+
|
|
113
384
|
---
|
|
114
385
|
|
|
115
386
|
## Understanding the Results
|
|
@@ -180,6 +451,17 @@ The AI assistant will present the analysis results in a readable format, typical
|
|
|
180
451
|
|
|
181
452
|
---
|
|
182
453
|
|
|
454
|
+
## Beta Version Feedback
|
|
455
|
+
|
|
456
|
+
As this is a beta release, we're actively seeking feedback to improve the CodeSherlock MCP Server. If you encounter any issues, have suggestions, or want to report bugs, please:
|
|
457
|
+
|
|
458
|
+
- Send us an email at [support@codesherlock.ai](mailto:support@codesherlock.ai)
|
|
459
|
+
- Include details about your environment, the issue you encountered, and any error messages
|
|
460
|
+
|
|
461
|
+
Your feedback helps us make CodeSherlock better for everyone!
|
|
462
|
+
|
|
463
|
+
---
|
|
464
|
+
|
|
183
465
|
## Getting Help
|
|
184
466
|
|
|
185
|
-
If you face any issues, please send us a mail at [support@codesherlock.ai](mailto:support@codesherlock.ai). We will help you resolve the issue as soon as possible.
|
|
467
|
+
If you face any issues, please send us a mail at [support@codesherlock.ai](mailto:support@codesherlock.ai). We will help you resolve the issue as soon as possible.
|