|
52 | 52 | - [🖼️ Showcase](#-showcase) |
53 | 53 | - [🚀 Quick Start](#-quick-start) |
54 | 54 | - [📖 User Guide](#-user-guide) |
| 55 | +- [🔧 API Documentation](#-api-documentation) |
55 | 56 | - [📝 Contribution Guide](#-contribution-guide) |
56 | 57 | - [🙏 Acknowledgements](#-acknowledgements) |
57 | 58 | - [💬 Join the Community](#-join-the-community) |
|
69 | 70 | | **MCP Server Scan** | Powered by AI Agent, Detects 9 major categories of MCP security risks, Supports source code/remote URL scanning. | |
70 | 71 | | **Jailbreak Evaluation** | Rapidly assesses Prompt security risks, Includes multiple curated jailbreak evaluation datasets, Cross-model security performance comparison. | |
71 | 72 | | **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 | |
72 | 74 | | **Multi-Language Support** | Chinese and English interface, Localized documentation and help. | |
73 | 75 | | **Cross-Platform Compatibility** | Linux, macOS, and Windows support, Docker-based deployment. | |
74 | 76 | | **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 |
143 | 145 | <br /> |
144 | 146 | <br> |
145 | 147 |
|
| 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 | + |
146 | 158 | ## 📝 Contribution Guide |
147 | 159 |
|
148 | 160 | 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 |
269 | 281 | [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) |
270 | 282 | [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) |
271 | 283 | [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) |
273 | 286 |
|
274 | 287 | 📧 If you have used A.I.G in your research, we would love to hear from you! [Contact us here](#-join-the-community). |
275 | 288 | <br> |
|
0 commit comments