README
🚀 ZeroPath MCP 服务器
ZeroPath MCP 服务器支持使用自然语言与产品安全漏洞进行交互。开发人员可直接从 ZeroPath 查询 SAST 问题、机密信息、补丁等,并在 Claude Desktop、Cursor、Windsurf 等兼容 MCP 环境的 AI 辅助工具中使用。无需仪表盘和手动票务分类,在工作环境中即可获取安全上下文。
🚀 快速开始
ZeroPath MCP 服务器允许开发人员直接从 ZeroPath 查询安全相关信息,并在兼容 MCP 环境的 AI 辅助工具中使用。无需复杂操作,在工作环境中即可获取安全上下文。
✨ 主要特性
- 自然语言交互:支持使用自然语言与产品安全漏洞进行交互。
- 多工具兼容:可在 Claude Desktop、Cursor、Windsurf 等兼容 MCP 环境的 AI 辅助工具中使用。
- 便捷获取信息:无需仪表盘和手动票务分类,在工作环境中即可获取安全上下文。
📦 安装指南
1. 生成 API 密钥
从您在 ZeroPath 组织设置中的 https://zeropath.com/app/settings/api 生成一个 API 密钥。
2. 配置环境变量
设置您的环境变量以包含 API 密钥:
export ZEROPATH_TOKEN_ID=your_token_id
export ZEROPATH_TOKEN_SECRET=your_token_secret
3. 获取您的组织 ID
运行以下命令获取您的组织 ID:
curl -X POST https://zeropath.com/api/v1/orgs/list \
-H "X-ZeroPath-API-Token-Id: $ZEROPATH_TOKEN_ID" \
-H "X-ZeroPath-API-Token-Secret: $ZEROPATH_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{}'
4. 安装 uv
我们使用 uv 进行依赖管理:
curl -LsSf https://astral.sh/uv/install.sh | sh
5. 克隆和设置
git clone https://github.com/ZeroPathAI/zeropath-mcp-server.git
cd zeropath-mcp-server
uv sync
export ZEROPATH_ORG_ID=your_org_id
📚 详细文档
配置
在您的 MCP 配置(如 Claude Desktop、Cursor 等)中添加以下条目:
{
"mcpServers": {
"zeropath-mcp-server": {
"command": "uv",
"args": [
"run",
"--project",
"<绝对克隆目录路径>/zeropath-mcp-server",
"<绝对克隆目录路径>/zeropath-mcp-server/main.py"
]
}
}
}
将 <absolute cloned directory path> 替换为仓库的绝对路径。
环境变量
在运行服务器之前导出以下内容:
export ZEROPATH_TOKEN_ID=your_token_id
export ZEROPATH_TOKEN_SECRET=your_token_secret
export ZEROPATH_ORG_ID=your_org_id
这些可以在您的 ZeroPath 设置中找到。
💻 使用示例
基础用法
搜索漏洞
vulns = search_vulnerabilities("critical")
获取问题
issue = get_issue(123)
print(f"问题 {issue['id']} 的严重性是 {issue['severity']}")
批准补丁
approve_patch(456)
高级用法
在开发模式下,要在本地测试工具而无需客户端连接:
uv run --project zeropath-mcp-server main.py
📄 博客文章
了解我们为什么构建此项目以及它如何适应不断发展的 AI 开发生态系统: 📄 与您的应用程序安全扫描对话:介绍 ZeroPath MCP 服务器
🤝 贡献指南
我们欢迎社区贡献!请参考我们的 CONTRIBUTING.md 文件了解如何参与。您可以通过以下方式与我们联系:
扫码联系在线客服