Bright MCP Tools
Bright's MCP tools and capabilities
Available Tools via the MCP Server
| Tool Name | Description | Use Case |
|---|---|---|
runScan | Start a security scan against selected entrypoints and tests. For private/local targets, a repeater must be specified and connected first. | Run a security scan on your API endpoints to detect vulnerabilities like SQL injection, XSS, etc. |
getScanStatus | Get the current status of a scan run. | Monitor the progress of an ongoing security scan to know when it completes. |
createRepeater | Create a repeater for accessing private/local targets. After creation, run the Bright CLI to start the repeater and establish connection. | Set up access to scan internal/private APIs that aren't publicly accessible. |
runDiscovery | Discover API endpoints using crawling (crawlerUrls) or API definitions (fileId from uploadApiDefinition). | Automatically find all API endpoints in your application before running security scans. |
getDiscoveryStatus | Get the current status of a discovery run. | Check if endpoint discovery has completed and how many endpoints were found. |
uploadApiDefinition | Upload an API definition file (OpenAPI/Swagger) by URL or content. Returns a file ID to reference in discovery runs. | Import your OpenAPI/Swagger spec to automatically create entrypoints for scanning. |
listProjects | List all projects available to the API key. Use this to find the project IDs needed for other operations. | Find the project ID you need before running scans or discoveries. |
listEntrypoints | List discovered API endpoints/URLs for a project. Use this to select entrypoints for scans or evaluate attack surface coverage. | Review all discovered endpoints before selecting which ones to include in a security scan. |
listTests | List available security tests (e.g., SQL injection, XSS) that can be run in scans. | See all available security test types to choose which vulnerabilities to test for. |
listRepeaters | List repeaters that route traffic to private/local targets. Use this to verify connection status before scanning non-public applications. | Check if your repeater is connected before attempting to scan private targets. |
listIssues | List security vulnerabilities found for a project. Use this after scan completion to review findings. | Review all discovered security vulnerabilities after a scan completes. |
listAuths | List authentication configurations for a project. Use this before scanning or discovering protected endpoints that require authentication/authorization. | Find authentication configs to use when scanning endpoints that require login. |
listScans | List scans for a project. Use this to view scan history and monitor scan progress. | Review past scan results or check the status of multiple ongoing scans. |
listDiscoveries | List discoveries for a project. Use this to view discovery history and monitor discovery progress. | Review past discovery runs or monitor ongoing endpoint discovery. |
addEntrypoint | Add a new entrypoint to a project. Entrypoints define HTTP requests that can be used for security scanning. | Manually add a specific API endpoint for security testing when automatic discovery isn't suitable. |
editEntrypoint | Update an existing entrypoint in a project. Use this to modify the HTTP request definition or associated parameters. | Modify an endpoint's request headers, body, or authentication settings before scanning. |
Updated about 12 hours ago