README
🚀 Bugcrowd MCP服务器
Bugcrowd MCP服务器项目提供了一个模型上下文协议(MCP)服务器,它将整个 Bugcrowd REST API 作为可调用工具暴露给大语言模型(LLMs)和自动化系统。该项目使用异步MCP SDK以Python语言实现,可与Claude Desktop、MCP Inspector或任何兼容的LLM代理配合使用。
🚀 快速开始
Bugcrowd MCP服务器可在大语言模型(如Claude、GPT等)与Bugcrowd平台之间架起桥梁。它将每个Bugcrowd API端点作为工具暴露出来,让你能够:
- 查询项目、提交内容、报告、资产、用户等信息
- 在Bugcrowd上创建、更新或删除资源
- 自动化漏洞管理和报告流程
- 将Bugcrowd数据集成到你自己的工作流、仪表盘或安全自动化系统中
所有API调用都是安全且异步进行的,并且不会硬编码凭证。
✨ 主要特性
- 全面覆盖Bugcrowd API:所有文档化的端点都可作为MCP工具使用(GET、POST、PATCH、DELETE等)。
- 异步且可扩展:采用异步Python和
httpx构建,具备高并发和响应能力。 - 安全可靠:凭证从环境变量中读取,不会硬编码。
- 易于集成:可直接与Claude Desktop或任何兼容MCP的客户端配合使用。
📦 安装指南
1. 安装依赖项
本项目使用 uv 进行快速Python依赖管理:
uv pip install -r requirements.txt
或者,如果你使用 pyproject.toml:
uv pip install .
2. 设置Bugcrowd API凭证
将你的Bugcrowd API用户名和密码导出为环境变量:
export BUGCROWD_API_USERNAME="your_username"
export BUGCROWD_API_PASSWORD="your_password"
⚠️ 重要提示
即使未设置这些环境变量,服务器也会启动并显示所有可用工具。但是,在提供凭证之前,任何调用Bugcrowd API工具的尝试都将导致运行时错误。
3. 运行MCP服务器
此服务器默认使用 标准输入输出传输(不启动HTTP服务器)。这是Claude Desktop和大多数LLM集成的推荐模式。
uv run server.py
4. 在Claude Desktop中进行配置
将以下内容添加到你的Claude Desktop mcpserver.json 配置文件中(根据需要调整目录路径):
{
"mcpServers": {
"BugcrowdMCP": {
"command": "uv",
"args": [
"--directory", "/Users/haji/mcp-servers/bugcrowd-mcp",
"run", "server.py"
]
}
}
}
⚠️ 重要提示
不启动HTTP服务器;所有通信都通过标准输入输出(stdio)进行,以确保与LLM工具的最大兼容性和安全性。
💻 使用示例
基础用法
一旦服务器运行并连接到你的LLM或MCP客户端,你就可以将任何Bugcrowd API端点作为工具调用。例如,列出所有项目:
# 向LLM或MCP客户端发出的提示
# Call the tool `get_programs` to list all Bugcrowd programs I have access to.
# 使用MCP客户端或LLM代理
result = call_tool("get_programs", {})
print(result)
高级用法
你还可以根据需要传递查询参数:
result = call_tool("get_programs", {"fields[program]": "name,code"})
通过ID获取特定项目:
result = call_tool("get_program", {"id": "PROGRAM_UUID"})
创建新报告:
result = call_tool("post_reports", {"data": {"type": "report", "attributes": {"title": "Test Report", "description": "Example."}}})
影响
- 大语言模型和代理:现在可以安全地以编程方式与完整的Bugcrowd API进行交互,实现自动化、报告以及与其他工具的集成。
- 安全团队:可以自动化漏洞管理、报告和从Bugcrowd提取数据的流程。
- 开发人员:可以利用Bugcrowd数据和操作快速原型化工作流,所有这些都通过单一、标准化的MCP接口完成。
📚 详细文档
项目结构
server.py:将Bugcrowd API端点作为工具暴露的主要MCP服务器。README.md:本项目文档。pyproject.toml:项目依赖项。
要求
📄 许可证
本项目采用MIT许可证。
Scan to join WeChat group