Skip to content

Commit a9d3ab5

Browse files
authored
Merge pull request #112 from zonashi/main
更新文档:添加API文档到Readme并更新论文
2 parents 9ed7a87 + 41bf252 commit a9d3ab5

4 files changed

Lines changed: 997 additions & 241 deletions

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
- [🖼️ Showcase](#-showcase)
5353
- [🚀 Quick Start](#-quick-start)
5454
- [📖 User Guide](#-user-guide)
55+
- [🔧 API Documentation](#-api-documentation)
5556
- [📝 Contribution Guide](#-contribution-guide)
5657
- [🙏 Acknowledgements](#-acknowledgements)
5758
- [💬 Join the Community](#-join-the-community)
@@ -69,6 +70,7 @@
6970
| **MCP Server Scan** | Powered by AI Agent, Detects 9 major categories of MCP security risks, Supports source code/remote URL scanning. |
7071
| **Jailbreak Evaluation** | Rapidly assesses Prompt security risks, Includes multiple curated jailbreak evaluation datasets, Cross-model security performance comparison. |
7172
| **Easy-to-use Web Interface​** | Modern, user-friendly web UI for seamless operation, One-click scanning with real-time progress tracking, Comprehensive Analysis Reports. |
73+
| **Convenient API** | Provides complete interface documentation and Swagger specifications for easier integration |
7274
| **Multi-Language Support** | Chinese and English interface, Localized documentation and help. |
7375
| **Cross-Platform Compatibility** | Linux, macOS, and Windows support, Docker-based deployment. |
7476
| **Free & Open Source​** | Offered​ completely free of charge ​under​ the MIT license. |
@@ -143,6 +145,16 @@ For more detailed FAQs and troubleshooting guides, visit our [documentation](htt
143145
<br />
144146
<br>
145147

148+
## 🔧 API Documentation
149+
150+
A.I.G provides a comprehensive set of task creation APIs that support AI infra scan, MCP Server Scan, and Jailbreak Evaluation capabilities.
151+
152+
After the project is running, visit `http://localhost:8088/docs/index.html` to view the complete API documentation.
153+
154+
For detailed API usage instructions, parameter descriptions, and complete example code, please refer to the [Complete API Documentation](./api.md).
155+
<br />
156+
<br>
157+
146158
## 📝 Contribution Guide
147159

148160
The extensible plugin framework​​ serves as A.I.G's architectural cornerstone, inviting community innovation through Plugin and Feature contributions.​
@@ -269,7 +281,8 @@ We are deeply grateful to the research teams who have used A.I.G in their academ
269281
[1] Yongjian Guo, Puzhuo Liu, et al. **"Systematic Analysis of MCP Security."** arXiv preprint arXiv:2508.12538 (2025). [[pdf]](https://arxiv.org/abs/2508.12538)
270282
[2] Zexin Wang, Jingjing Li, et al. **"A Survey on AgentOps: Categorization, Challenges, and Future Directions."** arXiv preprint arXiv:2508.02121 (2025). [[pdf]](https://arxiv.org/abs/2508.02121)
271283
[3] Yixuan Yang, Daoyuan Wu, Yufan Chen. **"MCPSecBench: A Systematic Security Benchmark and Playground for Testing Model Context Protocols."** arXiv preprint arXiv:2508.13220 (2025). [[pdf]](https://arxiv.org/abs/2508.13220)
272-
[4] Ping He, Changjiang Li, et al. **"Automatic Red Teaming LLM-based Agents with Model Context Protocol Tools."** arXiv preprint arXiv:2509.21011 (2025). [[pdf]](https://arxiv.org/abs/2509.21011)
284+
[4] Ping He, Changjiang Li, et al. **"Automatic Red Teaming LLM-based Agents with Model Context Protocol Tools."** arXiv preprint arXiv:2509.21011 (2025). [[pdf]](https://arxiv.org/abs/2509.21011)
285+
[5] Weibo Zhao, Jiahao Liu, Bonan Ruan et al. **"When MCP Servers Attack: Taxonomy, Feasibility, and Mitigation."** arXiv preprint arXiv:2509.24272v1 (2025). [[pdf]](http://arxiv.org/abs/2509.24272v1)
273286

274287
📧 If you have used A.I.G in your research, we would love to hear from you! [Contact us here](#-join-the-community).
275288
<br>

README_ZH.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
- [🖼️ 功能展示](#-功能展示)
5353
- [🚀 快速开始](#-快速开始)
5454
- [📖 用户指南](#-用户指南)
55+
- [🔧 API文档](#-api文档)
5556
- [📝 贡献指南](#-贡献指南)
5657
- [🙏 致谢](#-致谢)
5758
- [💬 加入社区](#-加入社区)
@@ -69,6 +70,7 @@
6970
| **MCP Server风险检测** | 基于AI Agent驱动,检测9大类MCP安全风险,支持源代码/远程URL扫描 |
7071
| **大模型安全体检** | 快速评估Prompt安全风险,内置多个精选越狱评估数据集,跨模型安全性能对比 |
7172
| **直观的Web界面** | 现代化、用户友好的Web UI,一键扫描实时进度跟踪,全面的结果分析报告 |
73+
| **便捷的API** | 提供完整的接口文档和Swagger规范,更方便集成 |
7274
| **多语言支持** | 拥有中英文界面,本地化帮助文档 |
7375
| **跨平台兼容** | 支持Linux、macOS和Windows,基于Docker部署 |
7476
| **免费且MIT开源** | 完全免费使用,MIT开源协议 |
@@ -129,7 +131,7 @@ docker-compose up -d
129131
```
130132

131133
服务启动后,您可以通过以下地址访问A.I.G的Web界面:
132-
`http://0.0.0.0:8088`
134+
`http://localhost:8088`
133135
<br><br>
134136

135137
注意: AI-Infra-Guard项目定位于企业或个人在内部使用的AI安全风险平台,暂无鉴权认证机制,请勿在公网中部署使用。
@@ -142,6 +144,16 @@ docker-compose up -d
142144
<br />
143145
<br>
144146

147+
## 🔧 API文档
148+
149+
A.I.G 提供了一套创建任务相关的API接口,支持AI基础设施扫描、MCP安全扫描和大模型安全体检功能。
150+
151+
项目运行后访问 `http://localhost:8088/docs/index.html` 可查看完整的API文档
152+
153+
详细的API使用说明、参数说明和完整示例代码,请查看 [完整API文档](./api_zh.md)
154+
<br />
155+
<br>
156+
145157
## 📝 贡献指南
146158

147159
A.I.G 的核心能力之一就是其丰富且可快速配置的插件系统。我们欢迎社区贡献高质量的插件和功能。
@@ -259,7 +271,8 @@ A.I.G 的核心能力之一就是其丰富且可快速配置的插件系统。
259271
[1] Yongjian Guo, Puzhuo Liu, et al. **"Systematic Analysis of MCP Security."** arXiv preprint arXiv:2508.12538 (2025). [[pdf]](https://arxiv.org/abs/2508.12538)
260272
[2] Zexin Wang, Jingjing Li, et al. **"A Survey on AgentOps: Categorization, Challenges, and Future Directions."** arXiv preprint arXiv:2508.02121 (2025). [[pdf]](https://arxiv.org/abs/2508.02121)
261273
[3] Yixuan Yang, Daoyuan Wu, Yufan Chen. **"MCPSecBench: A Systematic Security Benchmark and Playground for Testing Model Context Protocols."** arXiv preprint arXiv:2508.13220 (2025). [[pdf]](https://arxiv.org/abs/2508.13220)
262-
[4] Ping He, Changjiang Li, et al. **"Automatic Red Teaming LLM-based Agents with Model Context Protocol Tools."** arXiv preprint arXiv:2509.21011 (2025). [[pdf]](https://arxiv.org/abs/2509.21011)
274+
[4] Ping He, Changjiang Li, et al. **"Automatic Red Teaming LLM-based Agents with Model Context Protocol Tools."** arXiv preprint arXiv:2509.21011 (2025). [[pdf]](https://arxiv.org/abs/2509.21011)
275+
[5] Weibo Zhao, Jiahao Liu, Bonan Ruan et al. **"When MCP Servers Attack: Taxonomy, Feasibility, and Mitigation."** arXiv preprint arXiv:2509.24272v1 (2025). [[pdf]](http://arxiv.org/abs/2509.24272v1)
263276

264277
📧 如果您在研究中使用了A.I.G,请联系我们,让更多人看到您的研究!
265278
<br>

0 commit comments

Comments
 (0)