@sparrowai/sparrow-mcp 1.0.4 → 1.0.7
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 +17 -7
- package/dist/.tsbuildinfo +1 -1
- package/dist/config/appConfig.js +1 -1
- package/dist/server.js +1 -1
- package/dist/services/analysis.service.d.ts +6 -1
- package/dist/services/analysis.service.js +1 -1
- package/dist/services/llm.service.js +1 -1
- package/dist/services/s3.service.js +1 -1
- package/dist/services/sparrow.service.js +1 -1
- package/dist/types/types.d.ts +0 -3
- package/dist/types/types.js +1 -1
- package/dist/utils/crypto.util.js +1 -1
- package/dist/utils/diff.util.js +1 -1
- package/dist/utils/logger.js +1 -1
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -218,16 +218,25 @@ Get detailed results from a completed analysis.
|
|
|
218
218
|
|
|
219
219
|
**Parameters:**
|
|
220
220
|
- `analysisId` (string): The analysis ID
|
|
221
|
-
- `fileContent` (string): The original file content
|
|
222
221
|
|
|
223
222
|
**Returns:**
|
|
224
223
|
- `vulnerabilities`: List of discovered vulnerabilities
|
|
225
224
|
- `analysisBrief`: AI-generated analysis briefing
|
|
225
|
+
|
|
226
|
+
#### 4. `generate_secure_code`
|
|
227
|
+
|
|
228
|
+
Generate secure code based on analysis results.
|
|
229
|
+
|
|
230
|
+
**Parameters:**
|
|
231
|
+
- `analysisId` (string): The analysis ID from the security analysis
|
|
232
|
+
- `fileContent` (string): The original file content to generate secure version
|
|
233
|
+
|
|
234
|
+
**Returns:**
|
|
226
235
|
- `secureCode`: Generated secure code
|
|
227
236
|
- `secureCodeBrief`: Explanation of the secure code
|
|
228
237
|
- `diff`: Unified diff showing changes
|
|
229
238
|
|
|
230
|
-
####
|
|
239
|
+
#### 5. `analyze_files_security`
|
|
231
240
|
|
|
232
241
|
Analyze multiple files at once. Files are automatically zipped and analyzed.
|
|
233
242
|
|
|
@@ -240,7 +249,7 @@ Analyze multiple files at once. Files are automatically zipped and analyzed.
|
|
|
240
249
|
- `status`: Current analysis status
|
|
241
250
|
- `filePathCount`: Number of files being analyzed
|
|
242
251
|
|
|
243
|
-
####
|
|
252
|
+
#### 6. `analyze_zip_security`
|
|
244
253
|
|
|
245
254
|
Analyze a ZIP file for security vulnerabilities.
|
|
246
255
|
|
|
@@ -252,7 +261,7 @@ Analyze a ZIP file for security vulnerabilities.
|
|
|
252
261
|
- `analysisId`: Unique identifier for the analysis
|
|
253
262
|
- `status`: Current analysis status
|
|
254
263
|
|
|
255
|
-
####
|
|
264
|
+
#### 7. `analyze_folder_security`
|
|
256
265
|
|
|
257
266
|
Analyze an entire folder for security vulnerabilities. The folder is automatically zipped before analysis.
|
|
258
267
|
|
|
@@ -289,9 +298,10 @@ Track the progress of an analysis with real-time notifications.
|
|
|
289
298
|
1. **Write Code**: Write your Java code in Cursor
|
|
290
299
|
2. **Request Analysis**: Use the `analyze_file_security` tool to request analysis
|
|
291
300
|
3. **Track Progress**: Use `track_analysis_progress` to monitor the analysis
|
|
292
|
-
4. **Get Results**: Use `get_analysis_results` to retrieve detailed results
|
|
293
|
-
5. **
|
|
294
|
-
6. **
|
|
301
|
+
4. **Get Results**: Use `get_analysis_results` to retrieve detailed results (vulnerabilities and analysis briefing)
|
|
302
|
+
5. **Generate Secure Code** (Optional): Use `generate_secure_code` with the analysis ID and original file content to generate secure code
|
|
303
|
+
6. **Review**: Review the vulnerabilities, secure code, and diff
|
|
304
|
+
7. **Apply Changes**: Apply the suggested secure code changes
|
|
295
305
|
|
|
296
306
|
## 🐛 Troubleshooting
|
|
297
307
|
|