使用说明
Bright MCP集成
布莱特的 模型上下文协议(MCP) 整合带来 人工智能驱动的应用程序安全测试 直接进入您的开发工作流程。你的人工智能编码助手可以发现API端点,运行安全扫描,并审查漏洞-所有这些都通过自然语言对话。
Bright MCP是一个远程、云托管的MCP服务器。 本地无需安装任何东西-您只需将兼容MCP的客户端指向Bright的端点,并使用API密钥进行身份验证。
快速开始
1.获取明亮的API密钥
在您的Bright帐户中创建一个专用的API密钥。这可能是 个人的, 项目,或 组织层面 关键在于相关范围。看 个人API关键范围 了解详情。
2.配置您的客户端
将Bright添加为IDE或所选工具中的远程MCP服务器。服务器URL为:
https://app.brightsec.com/mcp
注: 如果您的组织使用专用的Bright群集,请替换
app.brightsec.com使用集群的主机名。
看 客户端配置 下面是IDE的具体说明。
3.开始使用它
问你的AI助手一些类似的问题:
Scan https://my-app.example.com for security vulnerabilities
您的助手将使用Bright MCP工具列出项目、发现入口点、运行扫描和报告结果。
客户端配置
VS代码(GitHub副本)
将以下内容添加到MCP配置中(通过命令面板→ “MCP:添加服务器”→ 全局,或手动编辑您的 mcp.json):
{
"servers": {
"brightsec.com": {
"type": "sse",
"url": "https://app.brightsec.com/mcp",
"headers": {
"Authorization": "Api-Key ${input:apiKey}"
}
}
},
"inputs": [
{
"type": "promptString",
"id": "apiKey",
"description": "Enter your Bright API Key",
"password": true
}
]
}
然后转到 扩展选项卡,右键单击 brightsec.com MCP服务器,并选择 启动服务器.系统将提示您输入API密钥。
完整指南: 在VS代码中配置Bright MCP
增强代码
- 打开 增强代码 扩展设置→ 工具 → 主控程序.
- 点击 +添加远程MCP.
- 填写:
- 连接类型: 超文本传输协议
- 身份验证类型: 头球
- 姓名: BrightSec
- 网址:
https://app.brightsec.com/mcp - 标题名称:
Authorization - 标题值:
Api-Key YOUR_API_KEY
- 点击 保存.
完整指南: 在增强代码中配置Bright MCP
光标
添加到光标MCP设置(.cursor/mcp.json):
{
"mcpServers": {
"brightsec": {
"url": "https://app.brightsec.com/mcp",
"headers": {
"Authorization": "Api-Key YOUR_API_KEY"
}
}
}
}
帆板运动
添加到您的Windsurf MCP配置(~/.codeium/windsurf/mcp_config.json):
{
"mcpServers": {
"brightsec": {
"serverUrl": "https://app.brightsec.com/mcp",
"headers": {
"Authorization": "Api-Key YOUR_API_KEY"
}
}
}
}
通用MCP客户端
任何支持MCP的兼容客户端 远程HTTP/SSE服务器 可以连接到Bright。配置它:
| 设置 | 值 |
|---|---|
| 运输 | SSE(服务器发送事件)或HTTP |
| 统一资源定位符 | https://app.brightsec.com/mcp |
| 身份验证标头 | Authorization: Api-Key YOUR_KEY |
可用工具
Bright MCP为您的AI助手提供以下工具:
项目管理
| 工具 | 说明 |
|---|---|
| 项目列表 | 列出API密钥可访问的所有项目。使用此功能查找其他操作所需的项目ID。 |
端点发现
| 工具 | 说明 |
|---|---|
| runDiscovery | 使用爬网发现API端点(crawlerUrls)或API定义(fileId 从 uploadApiDefinition).在运行之前,检查项目是否已经有入口点 listEntrypoints。对于专用/本地目标,请通过指定连接的中继器 repeaters. |
| getDiscoveryStatus | 获取发现运行的当前状态。 |
| 列表发现 | 列出项目的发现历史记录。查看过去的发现运行或监视正在进行的端点发现。 |
| uploadApiDefinition | 通过URL或内容上载API定义文件(OpenAPI/Swagger)。返回一个文件ID以在发现运行中引用。 |
入口点管理
| 工具 | 说明 |
|---|---|
| list入口点 | 列出已发现的项目的API终结点/URL。使用此选项可选择扫描的入口点或评估攻击面覆盖范围。支持通过HTTP方法、状态和文本搜索进行过滤。 |
| getEntry点 | 按ID获取特定入口点的详细信息,包括标头、正文和配置。 |
| addEntry点 | 向项目添加新入口点。入口点定义了可用于安全扫描的HTTP请求(方法、URL、标头、正文)。 |
| editEntry点 | 更新现有入口点。修改HTTP请求定义、身份验证或中继器设置。 |
安全扫描
| 工具 | 说明 |
|---|---|
| runScan | 对选定的入口点启动安全扫描。支持通过ID或状态来定位特定入口点(例如。, new, changed, vulnerable).配置要运行的测试或使用扫描模板。对于专用/本地目标,指定连接的中继器。 |
| getScanStatus | 获取正在运行的扫描的当前状态。 |
| list扫描 | 列出项目的扫描历史记录。查看过去的扫描结果或检查多个正在进行的扫描的状态。 |
| list测试 | 列出可以包含在扫描中的所有可用安全测试(例如SQL注入、XSS、CSRF)。 |
漏洞管理
| 工具 | 说明 |
|---|---|
| 列表问题 | 列出为项目发现的安全漏洞。按严重程度筛选(Low, Medium, High, Critical),状态(new, recurring, resolved, ignored),或入口点。 |
验证配置
| 工具 | 说明 |
|---|---|
| listAuths | 列出项目的身份验证配置。在扫描需要身份验证的受保护端点之前使用。 |
| getAuth | 获取有关特定身份验证配置的详细信息。 |
| addAuth | 创建新的身份验证配置。支持多种身份验证类型:静态标头、OAuth 2.0/OIDC、多步HTTP流、NTLM、基于浏览器的登录和记录的浏览器流。 |
| editAuth | 更新现有的身份验证配置。 |
私有/本地目标访问
| 工具 | 说明 |
|---|---|
| createRepeater | 创建中继器以访问私有/本地目标。创建后,运行Bright CLI启动中继器并建立连接。 |
| listRepeaters | 列出中继器及其连接状态。在扫描非公共应用程序之前,请验证中继器是否已连接。 |
用法示例
扫描公共应用程序
“扫描https://my-app.example.com安全漏洞”
助理将:
- 列出您的项目以找到合适的项目
- 获取项目的所有已发现入口点
- 对这些入口点进行安全扫描
- 监控扫描状态并报告结果
从OpenAPI规范中发现端点
“在上从OpenAPI规范中发现API终结点https://my-app.example.com/openapi.json"
助理将:
- 上传OpenAPI定义文件
- 运行基于文件的发现
- 监控发现状态
扫描本地/私有应用程序
“扫描我的本地应用程序http://localhost:3000"
助理将:
- 检查是否为中继器连接安装了Bright CLI
- 列出您的项目以找到合适的项目
- 如果需要,创建中继器
- 通过中继器运行安全扫描
- 监控扫描状态并报告结果
检查关键漏洞
“向我展示项目中的所有关键和高严重性问题”
助理将:
- 列出您的项目
- 查询问题按以下条件筛选
Critical和High严重性 - 详细介绍调查结果
带身份验证的扫描
“扫描需要承载令牌身份验证的API”
助理将:
- 创建或查找现有的身份验证配置
- 设置正确的标头/令牌流
- 在应用身份验证的情况下运行扫描
请参阅 examples/ 目录以获取更详细的工作流示例。
运作原理
┌─────────────────────┐ ┌──────────────────────┐
│ AI Assistant │ MCP │ Bright Cloud │
│ (VS Code, Cursor, │◄──────►│ (app.brightsec.com)│
│ Windsurf, etc.) │ SSE │ │
└─────────────────────┘ └──────────┬───────────┘
│
│ Scans
▼
┌──────────────────────┐
│ Your Application │
│ (public or via │
│ repeater) │
└──────────────────────┘
- 你的AI助手 通过SSE/HTTP连接到Bright的MCP端点。
- Bright的云平台 接收工具调用并协调安全操作。
- 扫描会针对您的应用程序运行 --直接(公共目标)或通过 中继器 (私人/本地目标)。
中继器(私人/本地目标)
为了扫描不可公开访问的应用程序,Bright使用 中继器 --轻量级代理,通过您的本地网络路由来自Bright云的扫描流量。
- 通过MCP工具创建中继器(
createRepeater) - 使用Bright CLI启动中继器:
bright-cli repeater \ --id <REPEATER_ID> \ --hostname app.brightsec.com \ --token <YOUR_API_KEY> - 运行扫描或发现时参考中继器
请参阅 Bright CLI安装指南 有关设置说明。
资源
许可证
此存储库包含Bright MCP集成的配置示例和文档。Bright的安全扫描平台是一款商业SaaS产品——访问 brightsec.com 了解更多信息。