文档
在你的 AI 编程工具中使用 AppSafe
把 AppSafe 连接到 Claude Code、Cursor 或其他任何 MCP 客户端,或者在你自己的脚本中调用 REST API。你的智能体可以扫描已验证的网站、读取每个问题的修复提示词、应用修复并重新检查,全部在一个循环里完成。
API、MCP 服务器和报告导出包含在 Pro、Agency 和 Team 套餐中。
1. 创建 API 密钥
前往仪表盘 → 账户 → API 密钥,为密钥命名并复制。密钥只显示一次,AppSafe 只保存其哈希值。密钥以 appsafe_ 开头,且只能用于你自己的网站。
2. 连接 MCP 服务器
服务器通过下方 URL 使用 Streamable HTTP,并以 bearer token 的形式使用你的 API 密钥进行身份验证。请把 YOUR_KEY 替换为你的密钥。
https://appsafe.dev/api/mcpClaude Code
运行一次此命令,或把这段 JSON 添加到项目中的 .mcp.json:
claude mcp add --transport http appsafe https://appsafe.dev/api/mcp \
--header "Authorization: Bearer YOUR_KEY"{
"mcpServers": {
"appsafe": {
"type": "http",
"url": "https://appsafe.dev/api/mcp",
"headers": {
"Authorization": "Bearer YOUR_KEY"
}
}
}
}Cursor
把这段内容添加到 ~/.cursor/mcp.json,或项目中的 .cursor/mcp.json:
{
"mcpServers": {
"appsafe": {
"url": "https://appsafe.dev/api/mcp",
"headers": {
"Authorization": "Bearer YOUR_KEY"
}
}
}
}其他 MCP 客户端:使用相同的 URL 和 Authorization 请求头。
工具
list_sites: 你的网站、是否已验证,以及最近一次扫描。start_scan: 按 URL 对已验证的网站启动完整扫描。未验证的网站会被拒绝,并附上验证方法说明。get_scan_status: 运行中、已完成或失败,附带分数、等级和各严重程度的数量。get_report: 以 Markdown(为智能体编写)、JSON 或 SARIF 格式返回报告。recheck_finding: 部署修复后,只重新运行某个问题背后的检查:已修复、仍存在或无法确定。
工作循环
- 让你的智能体用 AppSafe 扫描你的网站。
- 它读取 Markdown 报告,并按严重程度从高到低应用每个修复提示词。
- 你部署这些更改,因为 AppSafe 扫描的是线上网站。
- 智能体逐个重新检查问题,直到修复为止。
示例提示词:“用 AppSafe 扫描 myapp.com,修复严重和高危问题,并在我部署后重新检查。”
REST API
Base URL:https://appsafe.dev/api/v1。在 Authorization 请求头中以 Bearer YOUR_KEY 的形式发送你的密钥。OpenAPI 规范描述了所有端点。
| 端点 | 作用 |
|---|---|
| GET /sites | 列出你的网站 |
| POST /scans | 对已验证的网站启动完整扫描(siteId 或 url) |
| POST /sites/{id}/scans | 重新扫描单个网站 |
| GET /scans/{id} | 扫描状态、分数、等级和各严重程度的数量 |
| GET /scans/{id}/findings | 问题列表,含证据、修复提示词和重新检查用的 ref |
| GET /scans/{id}/report?format=markdown | 以 markdown、json 或 sarif 格式返回报告 |
| POST /findings/recheck | 按 ref 重新检查单个问题 |
示例
curl -X POST https://appsafe.dev/api/v1/scans \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://myapp.com"}'
curl "https://appsafe.dev/api/v1/scans/SCAN_ID/report?format=markdown" \
-H "Authorization: Bearer YOUR_KEY"报告导出
每次完成的扫描都可以导出为专为 AI 智能体编写的 Markdown(包含每个问题的证据、受影响的 URL、修复提示词和验证方法),或导出为供代码扫描工具使用的 SARIF 2.1.0。可在仪表盘中的扫描页面下载,或使用报告端点获取。
限制与安全
- 每个账户每 15 分钟 120 次 API 请求(其中重新检查 30 次),另需遵守你套餐的每日扫描和并发扫描限制。
- 完整扫描和重新检查只会在你已验证所有权的网站上运行。
- 所有响应中的密钥信息都会被脱敏,数据库相关问题只列出表名和字段名,绝不包含你的数据。
- 你可以随时在账户中撤销密钥,撤销后立即失效。