SOAR MCP Server
基于 Model Context Protocol (MCP) 的 SOAR 平台集成服务器,为 Claude Desktop、Cherry Studio、Cursor、Trae 等 AI 客户端提供安全编排、自动化和响应能力。
功能特性 • 快速开始 • 部署指南 • API文档 • 贡献指南
概述
SOAR MCP Server 是一个创新的安全编排平台集成解决方案,通过 Model Context Protocol 将 SOAR (Security Orchestration, Automation and Response) 能力直接集成到各种 AI 客户端中,包括 Claude Desktop、Cherry Studio、Cursor、Trae 等。它提供了完整的安全事件管理、剧本执行、威胁情报查询等功能,让 AI 助手具备专业的网络安全响应能力。
核心优势
🔒 安全编排:集成主流安全工具和平台
🤖 AI 驱动:通过多种 AI 客户端实现智能安全响应
⚡ 实时响应:快速处理安全事件和威胁
🌐 Web 管理:直观的可视化管理界面
🔧 灵活配置:支持多种部署和配置方式
功能特性
🛠️ MCP 工具集
剧本管理
list_playbooks
- 获取所有可用的 SOAR 剧本列表execute_playbook
- 执行 SOAR 剧本get_execution_status
- 获取剧本的执行状态
事件管理
create_event
- 创建新的安全事件list_events
- 获取安全事件列表
📊 MCP 资源
soar://playbooks
- SOAR 剧本列表soar://events
- 安全事件列表
🌐 Web 管理界面
剧本管理:可视化剧本列表、状态管理、执行监控
Token 管理:API 访问凭证的创建、管理和监控
系统配置:数据库连接、同步设置、API 配置
统计信息:系统状态、执行统计、性能监控
🚀 快速开始
本指南将带你从零开始部署和配置 SOAR MCP Server。
📋 环境要求
系统要求:
Python 3.8+
4GB+ 内存
网络连接(用于 SOAR API 访问)
支持平台:
Linux (Ubuntu 18.04+, CentOS 7+)
macOS (10.14+)
Windows 10/11
🛠️ 第一步:项目部署
1. 获取项目代码
2. 环境配置
3. 首次启动
🎉 恭喜!服务器已启动
首次运行时,系统会自动:
✅ 创建数据库和初始配置
✅ 生成管理员密码(控制台会显示)
✅ 启动 MCP 服务器和 Web 管理界面
⚠️ 跳过 SOAR 剧本同步(需要后续配置)
重要输出信息:
⚙️ 第二步:SOAR 平台配置
1. 访问管理后台
打开浏览器,访问
http://127.0.0.1:12346/admin
使用控制台显示的管理员密码登录
点击导航栏的「系统配置」
2. 配置 SOAR 连接
在系统配置页面填入以下信息:
配置项 | 说明 | 示例值 |
SOAR服务器API地址 | SOAR 平台的 API 基础地址 |
|
API Token | SOAR 平台的 JWT 认证令牌 |
|
超时时间 | API 请求超时(秒) |
|
同步周期 | 数据同步间隔 |
|
剧本抓取标签 | 过滤同步的剧本标签 |
|
3. 测试和保存
点击「测试连接」按钮验证配置
看到 ✅ "API连接测试成功!" 后,点击「保存配置」
系统将自动开始同步 SOAR 剧本数据
🤖 第三步:MCP 客户端配置
支持多种基于大模型的 MCP 客户端,包括但不限于:Cherry Studio、Claude Desktop、Cursor、Trae 等。
Cherry Studio(推荐)
打开 Cherry Studio
进入设置 → MCP 服务器
添加新服务器:
{ "name": "SOAR Security Platform", "type": "http", "url": "http://127.0.0.1:12345/mcp", "description": "SOAR 安全编排平台集成" }保存并连接
Claude Desktop
编辑 Claude Desktop 的 MCP 配置文件:
位置:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
Windows:
%APPDATA%\Claude\claude_desktop_config.json
配置内容:
⚠️ 重要:使用绝对路径,Claude Desktop 需要重启才能加载新配置
其他 MCP 客户端
通用配置参数:
协议:
Streamable HTTP
服务器 URL:
http://127.0.0.1:12345/mcp
认证: 无需额外认证头
🧪 第四步:功能验证
验证 MCP 连接
在 MCP 客户端中输入:
正常情况下会返回:
执行安全剧本
查看执行状态
🔧 管理工具
管理员密码重置
如果忘记了管理员密码,可以使用内置的重置脚本:
脚本特性:
🔒 安全随机密码生成(12位强密码)
🎨 用户友好的彩色界面
✅ 完善的环境检查和错误处理
🛡️ 确认机制防止误操作
使用示例:
高级配置
环境变量配置
如需固定配置,可创建 .env
文件:
系统服务配置
创建 systemd 服务(Linux):
API 文档
MCP 工具调用示例
执行安全剧本
查询执行状态
REST API 接口
详细的 REST API 文档请参考:API 文档
测试
运行测试套件
测试剧本执行
配置说明
环境变量
变量名 | 说明 | 默认值 | 必需 |
| SOAR 平台 API 地址 | - | ✅ |
| API 访问令牌 | - | ✅ |
| MCP 服务器端口 | 12345 | ❌ |
| Web 管理界面端口 | 12346 | ❌ |
| 数据库连接字符串 | sqlite:///soar_mcp.db | ❌ |
| SSL 证书验证 | 1 | ❌ |
| 调试模式 | 0 | ❌ |
数据库配置
支持多种数据库:
故障排除
常见问题
1. MCP 连接失败
症状:AI 客户端无法连接到 MCP 服务器
解决方案:
2. API 认证失败
症状:403 Forbidden 或 401 Unauthorized
解决方案:
检查
.env
文件中的API_TOKEN
是否正确确认 token 未过期
验证 API 地址是否正确
3. 数据库连接问题
症状:数据库操作失败
解决方案:
日志分析
贡献指南
我们欢迎社区贡献!请阅读 贡献指南 了解详细信息。
开发环境设置
提交代码
Fork 项目
创建功能分支:
git checkout -b feature/your-feature
提交更改:
git commit -am 'Add some feature'
推送分支:
git push origin feature/your-feature
创建 Pull Request
许可证
本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。
支持与反馈
🐛 问题反馈:GitHub Issues
💬 讨论交流:GitHub Discussions
📧 邮件联系:support@flagify.com
致谢
本项目的MCP服务器实现基于 FastMCP 框架构建。FastMCP 提供了优雅的 Python MCP 服务器开发体验,让我们能够快速构建高质量的 MCP 服务器。感谢 FastMCP 团队的优秀工作!
相关链接
Model Context Protocol - MCP 官方文档
FastMCP - Python MCP 服务器框架
OctoMation Wiki - SOAR 平台文档
雾帜智能 - 公司官网
雾帜智能@2025 | 最牛的SOAR | OctoMation
为 AI 赋能网络安全 🔒
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Integrates SOAR (Security Orchestration, Automation and Response) capabilities into AI clients, enabling security playbook execution, event management, and threat intelligence queries. Provides a complete security incident response platform through natural language interactions.