article
README
🚀 Yogosha MCP 服务器
本项目在 Yogosha 漏洞赏金平台和模型上下文协议(MCP)生态系统之间搭建了一座无缝桥梁。通过将所有 Yogosha API 端点作为 MCP 工具公开,它使安全团队、自动化工程师和 AI 副驾驶(如 Claude Desktop)能够以编程方式与 Yogosha 资源进行交互,而无需手动进行 API 调用或编写自定义脚本。
🚀 快速开始
项目影响
- 自动化:使用自然语言或工作流工具,立即自动执行漏洞管理、资产清单、报告等任务。
- 集成:将 Yogosha 与任何兼容 MCP 的代理、大语言模型(LLM)或工作流编排器(如 Claude Desktop、自定义机器人)连接起来。
- 安全性:通过环境变量强制进行 API 密钥管理,代码中不包含任何机密信息。所有操作都是无状态且可审计的。
- 可扩展性:只需扩展
server.py即可添加新的端点或自定义逻辑,无需修改核心基础设施。 - 提高生产力:显著减少对漏洞和资产进行分类、更新或报告所需的时间。
解决的问题
- 手动 API 工作:无需为每个 Yogosha API 调用编写自定义脚本,只需使用 MCP 工具界面。
- AI 副驾驶支持:让大语言模型和自动化代理直接管理你的漏洞赏金计划、资产和报告。
- 统一安全运营:使用 MCP 标准将 Yogosha 与其他安全工具和仪表盘集成。
📦 安装指南
项目要求
- Python 3.8 及以上版本
- uv(用于快速 Python 包管理和运行)
- Yogosha API 密钥
安装步骤
- 安装依赖项:
uv pip install -r requirements.txt - 设置 Yogosha API 密钥:
export YOGOSHA_API_KEY=your_yogosha_api_key_here - 运行 MCP 服务器:
服务器默认使用标准输入输出传输,以便与 Claude Desktop 和其他 MCP 客户端集成。uv run server.py
💻 使用示例
基础用法
服务器启动后,你可以使用 Claude Desktop 或任何 MCP 客户端执行以下操作:
- 列出所有项目:
list_programs() - 创建新资产:
create_asset(program_id, asset_data) - 修复漏洞:
patch_vulnerability(program_id, vulnerability_id, patch_data)
高级用法
在 Claude Desktop 中配置 MCP 服务器
要在 Claude Desktop 中使用此服务器,请将以下内容添加到你的 mcpserver.json 文件中:
{
"mcpServers": {
"YogoshaMCP": {
"command": "uv",
"args": [
"--directory",
"/Users/haji/mcp-servers/yogosha-mcp",
"run",
"server.py"
]
}
}
}
- 如果你的项目位于不同位置,请调整
--directory路径。 - 该服务器将在 Claude Desktop 中以 "YogoshaMCP" 的名称可用。
🔧 技术细节
安全性
- API 密钥从
YOGOSHA_API_KEY环境变量中读取。切勿将你的 API 密钥提交到源代码管理系统中。 - 所有代码都设计为无状态的,可安全用作 MCP 工具。
扩展性
- 要添加更多端点,只需遵循
server.py中的函数模式。
📄 许可证
本项目采用 MIT 许可证,或遵循本仓库中指定的许可证。
微信扫一扫