mobbdev 1.0.85 → 1.0.87

package/README.md

@@ -30,6 +30,8 @@ Bugsy does not detect any vulnerabilities in your code, it uses findings detecte
 
 ## Usage
 
+### Command Line Interface
+
 You can simply run Bugsy from the command line, using npx:
 
 ```shell
@@ -76,6 +78,88 @@ npx mobbdev scan -h
 npx mobbdev analyze -h
 ```
 
+### Model Context Protocol (MCP) Server
+
+Bugsy can also be used as an MCP server, allowing AI assistants like Claude to automatically scan and fix vulnerabilities in your code repositories.
+
+#### Prerequisites
+
+1. **API Key**: You need a Mobb API key to use the MCP server functionality
+   - Sign up at [mobb.ai](https://app.mobb.ai) to get your API key
+   - Set the `API_KEY` environment variable: `export API_KEY=your_api_key_here`
+
+2. **Local Git Repository**: The MCP server analyzes git repositories with uncommitted changes
+   - Make sure your code is in a local git repository
+   - Have some modified, added, or staged files to analyze
+
+#### Installation
+
+Run mobb-mcp from command line:
+
+```shell
+npx mobbdev mcp
+```
+
+#### Configuration
+
+Add Mobb MCP to your Cursor MCP client configuration:
+`API_URL` is only required if you are not using https://app.mobb.ai
+
+```json
+{
+  "mcpServers": {
+    "mobb-mcp": {
+      "command": "npx",
+      "args": ["mobbdev", "mcp"],
+      "env": {
+        "API_KEY": "your_mobb_api_key_here",
+        "API_URL": "optional__your_mobb_api_url_here"
+      }
+    }
+  }
+}
+```
+
+#### Usage
+
+Once configured, you can use the MCP server through your AI assistant:
+
+1. **Ask Claude to scan for vulnerabilities**:
+   ```
+   run a scan with mobb-mcp
+   ```
+   or
+   ```
+   run fix-vulnerabilities mcp tool
+   ```
+
+2. **The MCP server will**:
+   - Validate the repository path
+   - Check for git changes (modified, added, or staged files)
+   - Upload the changed files for analysis
+   - Generate automated fixes for detected vulnerabilities
+   - Return detailed fix recommendations
+
+#### Available MCP Tools
+
+- **`fix_vulnerabilities`**: Scans the current code changes and returns fixes for potential vulnerabilities
+  - **Parameter**: `path` (string) - The path to the local git repository
+  - **Returns**: Detailed vulnerability fixes with code patches and explanations
+
+#### Example MCP Workflow
+
+1. Make changes to your code
+2. Stage or modify files in git
+3. Ask your AI assistant: "Can you check my code for security vulnerabilities?"
+4. The assistant will use the MCP server to analyze your changes
+5. Receive detailed fix recommendations with code patches
+
+#### Troubleshooting
+
+- **"API_KEY environment variable is not set"**: Make sure you've set your Mobb API key
+- **"Path is not a valid git repository"**: Ensure you're pointing to a valid git repository
+- **"No changed files found"**: Make sure you have modified, added, or staged files in your repository
+
 ## Using Bugsy as part of a CI/CD pipeline
 
 If you utilize SAST scans as part of the CI/CD pipeline, Bugsy can be easiy added and provide immediate fix for every issue detected.