Breakout Scanner developer portal
Give Claude, Codex, or your own agent a controlled workspace for market research. Connect through authenticated MCP, discover the exact capability contract, and keep every write owner-scoped and reviewable.
The public contract is discovery-first. Authentication, no-card trial or Pro entitlement, client grants, and runtime checks still apply; a link or schema never grants access.
The public contract
What is ready today
The labels below describe the current product boundary, including what is deliberately still in preview. That distinction matters when an agent is choosing a client or planning an integration.
| Surface | Status | Details |
|---|---|---|
| Authenticated MCP | Available | Live Streamable HTTP endpoint for active no-card trial or Pro accounts (7-day free trial, no card needed. Then $20/month.). All five write families and representative bounded adapters for all ten read contracts execute today, including inline/artifact-backed screen.evaluate and backtest.run, artifact-backed candidates.rank, and bounded multi-symbol company.compare. Unsupported schema shapes and data primitives return typed capability gaps. OAuth, grants, approval mode, and revocation remain independent per connection.MCP endpoint |
| OpenAPI 3.1 | Live | Generated from the same canonical capability registry used by MCP tools/list. It describes discovery and MCP transport, not a direct REST database API.OpenAPI JSON |
| TypeScript SDK | Preview | The public @breakoutscanner/mcp-sdk package provides contract discovery and authenticated calls. Version 0.1.0-preview.2 is available through npm's preview tag; it prefers MCP 2026-07-28 and safely falls back to 2025-11-25/2025-06-18.Open the npm package |
| CLI | Preview | The public @breakoutscanner/mcp-cli package can discover capabilities, list tools, and call MCP. Version 0.1.0-preview.2 is available through npm's preview tag; it prefers MCP 2026-07-28 and safely falls back to 2025-11-25/2025-06-18. Credentials remain in the client environment and calls remain synchronous.Open the npm package |
| NLWeb site search | Available | Public NLWeb 0.55 list-mode GET/POST endpoint over the fixed product and documentation catalog. JSON and SSE are supported without model spend, account access, or workspace mutation.Try public search |
| Public docs MCP | Available | Anonymous read-only MCP over six server-owned Markdown documents. Three bounded tools support discovery without account access, live data, models, persistence, network calls, or writes.Open server card |
| Public sandbox | Available | Anonymous, stateless protocol test surface with fixed stale fixtures. It has no account, live data, model budget, network, persistence, or workspace mutation; watchlist writes are simulated proposals only.Open sandbox endpoint |
Discover before you call
Start with the public contract. It is generated from the same finite registry that powers MCP tools/list, so a client can validate names, versions, bounds, and write approval requirements before opening a session. Registration describes the stable target contract; inspect the structured tool result because each representative adapter remains bounded by supported schema and data shapes.
npm install @breakoutscanner/[email protected]
npx --yes --package=@breakoutscanner/[email protected] \
breakout-scanner discoverconst contract = await fetch("https://breakoutscanner.com/api/v1/capabilities", {
headers: { Accept: "application/json" },
}).then((response) => response.json());
const mcp = "https://breakoutscanner.com/mcp";
const openapi = "https://breakoutscanner.com/openapi.json";
console.log(contract.capabilities.map((item) => item.name));A market workspace, not a trading API
The current registry contains 11 read contracts and 6 write contracts. Direct MCP execution now has representative bounded adapters for all ten reads and all five write proposal families, including inline/artifact-backed screen.evaluate and backtest.run, artifact-backed candidates.rank, and bounded multi-symbol company.compare. Unsupported schema shapes and data primitives return typed capability gaps. Reads remain owner-scoped and evidence-bounded. Writes follow the connection's approval mode and never expose SQL, arbitrary code execution, brokers, orders, or trade placement.
Authentication
OAuth 2.1 Authorization Code + PKCE, with RFC 9728 protected-resource discovery.
Operations
Idempotent MCP calls, rate-limit signaling, structured failures, and request IDs for support.
Need access or have an integration question? Contact support. For client-specific connection instructions, use the authenticated MCP docs.