-
Notifications
You must be signed in to change notification settings - Fork 2.6k
docs: add BurpSuite MCP server integration documentation #6845
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Created comprehensive documentation for BurpSuite MCP server setup - Added installation, configuration, and troubleshooting guides - Created MCP servers documentation directory structure - Updated main README with link to MCP server integrations Fixes #6844
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewing my own documentation is like proofreading a ransom note I wrote to myself.
| "mcpServers": { | ||
| "burpsuite": { | ||
| "command": "java", | ||
| "args": ["-jar", "/path/to/mcp-server/build/libs/mcp-proxy-all.jar", "--sse-url", "http://127.0.0.1:9876"], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Critical issue: The JAR file name here doesn't match what's created in the build step. The build creates burp-mcp-all.jar (line 44), but this references mcp-proxy-all.jar. This mismatch will cause the configuration to fail.
| "mcpServers": { | ||
| "burpsuite": { | ||
| "command": "java", | ||
| "args": ["-jar", "/path/to/mcp-proxy-all.jar", "--sse-url", "http://127.0.0.1:9876"], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same JAR file name issue here - should be burp-mcp-all.jar to match the build output:
| 2. Build the extension JAR file: | ||
|
|
||
| ```bash | ||
| ./gradlew embedProxyJar |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This command won't work on Windows. Could we add a note for Windows users?
bash
# On Linux/macOS:
./gradlew embedProxyJar
# On Windows:
gradlew.bat embedProxyJar
| ### Permission Errors | ||
|
|
||
| - Ensure the JAR file path is correct and accessible | ||
| - On macOS/Linux, ensure the JAR file has execute permissions: `chmod +x mcp-proxy-all.jar` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this necessary? JAR files don't need execute permissions since they're run through the Java interpreter. This command won't cause issues but might confuse users. Consider removing this line or clarifying that it's not typically needed.
| Before setting up the BurpSuite MCP server, ensure you have: | ||
|
|
||
| 1. **Burp Suite Professional or Community Edition** installed and running | ||
| 2. **Java** installed and available in your system's PATH |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we specify which Java version is required? The BurpSuite MCP server might have specific version requirements (e.g., Java 11 or higher).
|
|
||
| Before setting up the BurpSuite MCP server, ensure you have: | ||
|
|
||
| 1. **Burp Suite Professional or Community Edition** installed and running |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be helpful to specify which versions of Burp Suite are compatible with this MCP server? This could prevent users from encountering compatibility issues.
|
MCP Marketplace addition request |
This PR adds comprehensive documentation for integrating the BurpSuite MCP server with Roo-Code.
Changes
docs/mcp-servers/)Related Issue
Fixes #6844
Documentation Added
docs/mcp-servers/burpsuite.md- Complete guide for BurpSuite MCP server integrationdocs/mcp-servers/README.md- Index page for MCP server documentationThis documentation enables users to integrate BurpSuite with Roo-Code through the Model Context Protocol, allowing AI assistants to interact with Burp Suite for security testing and web application analysis.
Important
Adds documentation for BurpSuite MCP server integration with Roo-Code, including setup and troubleshooting guides.
docs/mcp-servers/burpsuite.mdfor BurpSuite MCP server integration.docs/mcp-servers/README.mdas an index for MCP server documentation.README.mdwith a link to MCP server integrations.docs/mcp-servers/directory for MCP server documentation.This description was created by
for a1b0374. You can customize this summary. It will automatically update as commits are pushed.