44
55---
66
7- <a id =" 中文 " ></a >
7+ ` <a id="中文"></a> `
88
99# Burp Suite MCP Server -- 魔改增强版
1010
@@ -64,12 +64,12 @@ http://127.0.0.1:9876/mcp
6464
6565``` json
6666{
67- "mcpServers" : {
68- "burp" : {
69- "type" : " http" ,
70- "url" : " http://127.0.0.1:9876/mcp"
71- }
72- }
67+ "mcpServers" : {
68+ "burp" : {
69+ "type" : " http" ,
70+ "url" : " http://127.0.0.1:9876/mcp"
71+ }
72+ }
7373}
7474```
7575
@@ -81,17 +81,17 @@ http://127.0.0.1:9876/mcp
8181
8282``` json
8383{
84- "mcpServers" : {
85- "burp" : {
86- "command" : " java" ,
87- "args" : [
88- " -jar" ,
89- " /path/to/mcp-proxy-all.jar" ,
90- " --sse-url" ,
91- " http://127.0.0.1:9876/sse"
92- ]
93- }
94- }
84+ "mcpServers" : {
85+ "burp" : {
86+ "command" : " java" ,
87+ "args" : [
88+ " -jar" ,
89+ " /path/to/mcp-proxy-all.jar" ,
90+ " --sse-url" ,
91+ " http://127.0.0.1:9876/sse"
92+ ]
93+ }
94+ }
9595}
9696```
9797
@@ -258,16 +258,16 @@ http://127.0.0.1:9876/mcp
258258
259259## 配置说明
260260
261- | 选项 | 说明 | 默认值 |
262- | ------| ------| --------|
263- | 服务器主机 | 监听地址 | ` 127.0.0.1 ` |
264- | 服务器端口 | 监听端口 | ` 9876 ` |
265- | 严格 localhost 模式 | WSL/远程环境需关闭 | 开启 |
266- | 启用保活心跳 | SSE 连接保活 | 开启 |
267- | 保活间隔 | 心跳间隔(秒) | 30s |
268- | 最大响应大小 | 单次响应上限(KB) | 100KB |
269- | HTTP 请求审批 | 发送 HTTP 前需确认 | 开启 |
270- | 历史记录访问审批 | 读取历史前需确认 | 开启 |
261+ | 选项 | 说明 | 默认值 |
262+ | ------------------- | ------------------ | ----------- |
263+ | 服务器主机 | 监听地址 | ` 127.0.0.1 ` |
264+ | 服务器端口 | 监听端口 | ` 9876 ` |
265+ | 严格 localhost 模式 | WSL/远程环境需关闭 | 开启 |
266+ | 启用保活心跳 | SSE 连接保活 | 开启 |
267+ | 保活间隔 | 心跳间隔(秒) | 30s |
268+ | 最大响应大小 | 单次响应上限(KB) | 100KB |
269+ | HTTP 请求审批 | 发送 HTTP 前需确认 | 开启 |
270+ | 历史记录访问审批 | 读取历史前需确认 | 开启 |
271271
272272## 详细能力说明
273273
@@ -320,68 +320,11 @@ http://127.0.0.1:9876/mcp
320320
321321## 构建命令
322322
323- | 命令 | 说明 |
324- | ------| ------|
323+ | 命令 | 说明 |
324+ | ------------------------- | -------------------------- |
325325| ` ./gradlew embedProxyJar ` | 构建最终可分发 JAR(推荐) |
326- | ` ./gradlew test ` | 运行测试 |
327- | ` ./gradlew shadowJar ` | 仅构建主 JAR |
328-
329- ## 自动发布
330-
331- 仓库内置了两条 GitHub Actions 流水线:
332-
333- - ` CI `
334- 每次 push 到 ` master ` 时自动测试、构建,并上传构建产物 Artifact
335- - ` Release `
336- 推送 tag ` v* ` 时自动正式发布 GitHub Release
337- 也支持在 GitHub Actions 页面手动触发
338-
339- 推荐发布流程:
340-
341- ``` bash
342- git push origin master
343- git tag v1.2.2
344- git push origin v1.2.2
345- ```
346-
347- CI 会自动:
348-
349- - 使用 Java 21 构建
350- - 执行测试
351- - 执行 ` ./gradlew embedProxyJar `
352- - 上传 ` build/libs/burp-mcp-all.jar ` 作为 Actions Artifact
353-
354- Release 会自动:
355-
356- - 使用 Java 21 构建
357- - 执行测试
358- - 执行 ` ./gradlew embedProxyJar `
359- - 上传 ` build/libs/burp-mcp-all.jar `
360- - 创建或更新对应版本 Release
361- - 基于 GitHub 提交记录自动生成 Release notes
362-
363- ## 开发
364-
365- 工具定义主要位于:
366-
367- ``` text
368- src/main/kotlin/net/portswigger/mcp/tools/
369- ```
370-
371- 新增工具时,创建 ` @Serializable ` 参数类并在 ` Tools.kt ` 注册即可:
372-
373- ``` kotlin
374- @Serializable
375- data class MyToolArgs (val param : String )
376-
377- mcpTool<MyToolArgs >(" 工具描述" ) {
378- // your logic
379- }
380- ```
381-
382- ---
383-
384- <a id =" english " ></a >
326+ | ` ./gradlew test ` | 运行测试 |
327+ | ` ./gradlew shadowJar ` | 仅构建主 JAR |
385328
386329# Burp Suite MCP Server -- Enhanced Edition
387330
@@ -434,30 +377,30 @@ Recommended:
434377
435378``` json
436379{
437- "mcpServers" : {
438- "burp" : {
439- "type" : " http" ,
440- "url" : " http://127.0.0.1:9876/mcp"
441- }
442- }
380+ "mcpServers" : {
381+ "burp" : {
382+ "type" : " http" ,
383+ "url" : " http://127.0.0.1:9876/mcp"
384+ }
385+ }
443386}
444387```
445388
446389For stdio-only clients:
447390
448391``` json
449392{
450- "mcpServers" : {
451- "burp" : {
452- "command" : " java" ,
453- "args" : [
454- " -jar" ,
455- " /path/to/mcp-proxy-all.jar" ,
456- " --sse-url" ,
457- " http://127.0.0.1:9876/sse"
458- ]
459- }
460- }
393+ "mcpServers" : {
394+ "burp" : {
395+ "command" : " java" ,
396+ "args" : [
397+ " -jar" ,
398+ " /path/to/mcp-proxy-all.jar" ,
399+ " --sse-url" ,
400+ " http://127.0.0.1:9876/sse"
401+ ]
402+ }
403+ }
461404}
462405```
463406
@@ -553,42 +496,8 @@ Monitor server/cache state and adjust runtime behavior from the built-in dashboa
553496
554497## Build Commands
555498
556- | Command | Description |
557- | ---------| -------------|
499+ | Command | Description |
500+ | ------------------------- | --------------------------- |
558501| ` ./gradlew embedProxyJar ` | Build the distributable JAR |
559- | ` ./gradlew test ` | Run tests |
560- | ` ./gradlew shadowJar ` | Build the main JAR only |
561-
562- ## Automated Releases
563-
564- This repository includes two GitHub Actions workflows:
565-
566- - ` CI `
567- builds and uploads an artifact on every push to ` master `
568- - ` Release `
569- creates a formal GitHub Release when you push a ` v* ` tag
570- and can also be triggered manually from the Actions tab
571-
572- Recommended flow:
573-
574- ``` bash
575- git push origin master
576- git tag v1.2.2
577- git push origin v1.2.2
578- ```
579-
580- CI will:
581-
582- - build with Java 21
583- - run tests
584- - run ` ./gradlew embedProxyJar `
585- - upload ` build/libs/burp-mcp-all.jar ` as an Actions artifact
586-
587- Release will:
588-
589- - build with Java 21
590- - run tests
591- - run ` ./gradlew embedProxyJar `
592- - upload ` build/libs/burp-mcp-all.jar `
593- - create or update the matching GitHub Release
594- - generate Release notes automatically from GitHub commit history
502+ | ` ./gradlew test ` | Run tests |
503+ | ` ./gradlew shadowJar ` | Build the main JAR only |
0 commit comments