Skip to content

brapi.dev

Strong technical baseline

What should the prompt cover?

10 findings · 5 selected

Failures (2)

Warnings (8)

Task

What does brapi.dev do and who is it for? Explain it back to me.

Waiting for the agent’s first step…

Critical access needs attention

These checks describe whether an ordinary agent can enter, read, and operate the public site.

  • Agents can reach the site

    Crawler access and bot defenses.

    2 / 2 passed
  • Core content is available

    Useful content remains accessible without a fragile browser-only path.

    1 / 2 passed
  • Navigation fails safely

    Redirects and missing pages give agents a recoverable path.

    1 / 2 passed
  • Controls are understandable

    Forms and interactive controls expose usable names and structure.

    3 / 3 passed

Evaluated surfaces have material gaps

The public website is always evaluated. Optional surfaces appear when the scan finds positive evidence that they apply.

Public website

Ready with gaps

81%

13 of 18 mature checks passed

API

Strong

90%

9 of 12 mature checks passed

Authentication

Ready with gaps

83%

2 of 3 mature checks passed

MCP

Needs work

50%

0 of 1 mature checks passed

Fix these gaps first

Critical access gaps come first, followed by other applicable readiness gaps.

  1. 01

    Agent-friendly 404s

    Return a real HTTP 404 (or 410) status for nonexistent paths - never a 200 with your app shell, which makes agents believe every path exists. For full credit, give the 404 response a short markdown body pointing agents at your sitemap, llms.txt, or docs index. Verify with curl -s -o /dev/null -w "%{http_code}" https://yourdomain.com/some-path-that-does-not-exist - it must print 404.

    Critical access
  2. 02

    Content without JavaScript

    Server-side render your homepage so AI crawlers see meaningful content without JavaScript. Ensure an H1 and 500+ chars of text in raw HTML.

    Critical access
  3. 03

    Developer resource discoverability

    Make your developer resources (API docs, OpenAPI spec, auth docs, webhooks, MCP server) discoverable by name. Publish them at predictable URLs, list them in llms.txt, and include your product name in page titles and headings so search engines surface them for name-based queries.

    Other readiness checks
  4. 04

    Brand name discoverability

    Make sure a clean search for your brand name returns your own domain in the top results. If it does not, your brand may be too generic, conflict with a more established term, or not yet indexed. Strengthen brand-name search by claiming consistent NAP across listings, earning press mentions that link to the canonical domain, and avoiding redirect chains that mask the apex domain in search results.

    Other readiness checks
  5. 05

    MCP server / manifest

    Build an MCP (Model Context Protocol) server exposing your API as tools. Use Streamable HTTP transport for full score. This lets Claude, ChatGPT, and other AI agents call your product natively.

    Other readiness checks

Audit the checks behind the score

Applicable evidence is grouped by how it contributes to this preview model. Bonus checks appear only when they add points.

Essential9 of 11 passed · 73.9 / 80 points
  • Content without JavaScriptPartial (67%)

    15067 chars with H1 but flat heading structure

    Recommendation

    Server-side render your homepage so AI crawlers see meaningful content without JavaScript. Ensure an H1 and 500+ chars of text in raw HTML.

  • Not blocked by bot detectionPassed

    Site accessible to 6 AI agent user-agents

    Recommendation

    Allowlist known AI agent User-Agents (ChatGPT-User, ClaudeBot, Google-Extended, DeepSeekBot) in your WAF or bot-detection rules.

  • Redirect hygienePassed

    No meta-refresh stubs, JavaScript-redirect stubs, or cross-domain hops across 6 checked pages

    Recommendation

    Replace meta-refresh and JavaScript-only redirects with real HTTP 301/302 redirects. Non-JS agents never execute location.href or wait for a meta refresh - they see only the stub page. Verify with curl -sI <url> - you should see a Location header, not a 200 with a near-empty body.

  • Content behind authPassed

    All 5 sampled pages are publicly readable (5 with substantive content)

    Recommendation

    Serve your content pages without a login wall. Agents cannot complete auth flows while browsing - a 401/403 or a login-form page is invisible content. Keep public documentation public; if some content must stay gated, publish an ungated summary so agents can still represent it.

  • OpenAPI spec publishedPassed

    OpenAPI spec found at https://brapi.dev/openapi.json (version: 3.1.0)

    Recommendation

    Publish an OpenAPI (Swagger) specification at /openapi.json or /api/openapi.yaml. This is how agents understand your API surface automatically.

  • Markdown content negotiation (acceptmarkdown.com)Passed

    Canonical URL serves text/markdown and text/html via Accept negotiation with Vary: Accept

    Recommendation

    On the responses that serve text/markdown via Accept negotiation, add Accept to the Vary header (Vary: Accept, Accept-Encoding). Without it, CDNs can serve the cached HTML variant to an agent asking for markdown (or vice versa), depending on which variant landed in cache first.

  • Agent crawler reachabilityPassed

    Reachable to all major AI crawlers - ChatGPT-User: reachable, ClaudeBot: reachable, Google-Extended: reachable, ora-agent: reachable, DeepSeekBot: reachable

    Recommendation

    Verify that major agent User-Agents can reach the homepage. If your WAF or bot rules block them, remove or narrow the blocking rule. Add an allow rule only when your security setup denies them by default.

  • OAuth 2.0 supportPassed

    OAuth authorization server metadata at https://brapi.dev (issuer=https://brapi.dev)

    Recommendation

    Implement OAuth 2.0 for API authentication. Publish your authorization server metadata at /.well-known/oauth-authorization-server.

  • Scoped permissionsPassed

    Security schemes defined in OpenAPI spec

    Recommendation

    Support scoped API permissions (OAuth scopes or API key roles) so agents can request only the access they need.

  • JSON error responsesPassed

    API returns JSON error responses (404 at https://api.brapi.dev/orank-probe-test)

    Recommendation

    Return structured JSON error responses with error codes, messages, and resolution hints. Agents can't parse HTML error pages.

  • Agent-friendly 404sPartial (50%)

    Nonexistent paths return a real HTTP 404. For full credit, include a short markdown body (site map links, where to look next) so agents can recover.

    Recommendation

    Return a real HTTP 404 (or 410) status for nonexistent paths - never a 200 with your app shell, which makes agents believe every path exists. For full credit, give the 404 response a short markdown body pointing agents at your sitemap, llms.txt, or docs index. Verify with curl -s -o /dev/null -w "%{http_code}" https://yourdomain.com/some-path-that-does-not-exist - it must print 404.

Recommended15 of 23 passed · 15.9 / 20 points
  • Developer resource discoverabilityFailed

    Agent searched for "brapi" developer resources but found nothing relevant

    Recommendation

    Make your developer resources (API docs, OpenAPI spec, auth docs, webhooks, MCP server) discoverable by name. Publish them at predictable URLs, list them in llms.txt, and include your product name in page titles and headings so search engines surface them for name-based queries.

  • Brand name discoverabilityFailed

    "ASL Tecnologia LTDA" search returned 9 results but domain did not appear - brand may be too generic or not indexed

    Recommendation

    Make sure a clean search for your brand name returns your own domain in the top results. If it does not, your brand may be too generic, conflict with a more established term, or not yet indexed. Strengthen brand-name search by claiming consistent NAP across listings, earning press mentions that link to the canonical domain, and avoiding redirect chains that mask the apex domain in search results.

  • Sitemap existsPassed

    Valid sitemap found at https://brapi.dev/sitemap.xml with 2654 entries

    Recommendation

    Add a valid XML sitemap at /sitemap.xml listing all indexable URLs. Include lastmod dates and keep it under 50MB.

  • Content efficiencyPartial (50%)

    Low content efficiency: 3.41% - most of the page is markup, not content

    Recommendation

    Reduce markup overhead so readable text is at least 5% of your HTML. Strip unused inline scripts/styles, server-render content instead of shipping large JSON hydration blobs, and keep wrapper nesting shallow.

  • JSON-LD structured dataPassed

    Rich JSON-LD identity: WebApplication with name, description, url, and category/offers (18 block(s))

    Recommendation

    Add JSON-LD structured data to your homepage using the identity type that matches your site - SoftwareApplication for products, Organization or LocalBusiness for companies, Person for personal sites, Article for blogs - with name, description, url, and type-appropriate fields (offers, sameAs, author) so AI can parse your identity programmatically.

  • Public API/docs linked from homepagePassed

    API/docs link found on homepage and resolves: /docs

    Recommendation

    Publish API documentation at a discoverable URL (/docs, /api, /developers). Include authentication, endpoints, and example requests.

  • Agent instruction / when-to-usePassed

    When-to-use guidance found in llms.txt

    Recommendation

    Tell agents when to reach for you: add a 'when to use this' section to your llms.txt (or a dedicated agent-instructions file) that names your best-fit use cases and how an agent should call you. Be specific about the jobs you are right for - generic marketing copy does not read as guidance.

  • Metadata completenessPassed

    All metadata signals present: canonical URL, lang="pt-BR", og:image, og:type

    Recommendation

    Add all four signals to your homepage: , , , and . Agents use these for entity resolution and attribution.

  • Organization schema completenessPassed

    Organization schema complete with contactPoint and address

    Recommendation

    Add Organization JSON-LD that includes both contactPoint (with email/phone and contactType) and address (PostalAddress). This lets AI verify your business legitimacy and answer contact queries.

  • Trust anchor pagesPassed

    All trust anchor pages verified: About, Contact, Privacy

    Recommendation

    Publish real /about, /contact, and /privacy pages with at least 500 characters of content each. These are the pages AI agents check to verify your business is legitimate before recommending you.

  • Page token budgetPassed

    All 12 measured pages fit an agent context budget (largest ~4K tokens)

    Recommendation

    Keep each page's extracted text under ~100K characters (~25K tokens) so it fits an agent's context window without truncation. Split oversized reference pages into focused per-topic documents and link them from an index. Check a page with curl -s <url> | wc -c and remember agents read the extracted text, not the raw HTML.

  • Code fence validityPassed

    Code fences balanced across 5 markdown documents

    Recommendation

    Close every fenced code block (``` or ~~~) in your served markdown. CommonMark treats everything after an unclosed fence as code, so an agent parsing the document silently loses the rest of it. Count fence lines per file - the total must be even.

  • Developer portalPassed

    Developer portal found at /docs

    Recommendation

    Create a developer portal at /developers with API keys, documentation, quickstart guides, and a sandbox environment.

  • Public API with reachable endpointsPassed

    REST API documentation found at https://brapi.dev/docs. Best-of-protocols score: 7/7.

    Recommendation

    Expose a public REST or GraphQL API. AI agents need programmatic access - not just a web UI - to integrate with your product.

  • Agent onboarding frictionPartial (50%)

    Moderate friction: sandbox/test environment

    Recommendation

    Offer a free tier or trial, self-serve API key generation, and a sandbox environment. Agents can't fill out 'contact sales' forms.

  • MCP server / manifestPartial (50%)

    MCP manifest found at /.well-known/mcp.json but protocol handshake failed

    Recommendation

    Build an MCP (Model Context Protocol) server exposing your API as tools. Use Streamable HTTP transport for full score. This lets Claude, ChatGPT, and other AI agents call your product natively.

  • Rate limit response headersPassed

    The live API at https://api.brapi.dev/ returns IETF RateLimit-* headers: ratelimit-limit, ratelimit-remaining, ratelimit-reset.

    Recommendation

    Return standard rate-limit headers on your API responses (the RFC RateLimit headers, plus Retry-After on a 429) so agents can self-throttle in real time, and document the conventions alongside your API.

  • REST typed error modelPassed

    OpenAPI defines a typed error schema in components.schemas and 4xx/5xx responses reference it

    Recommendation

    Document your error responses in your OpenAPI spec: give 4xx and 5xx responses a typed error schema (or use RFC 9457 application/problem+json). A consistent error object with a machine-readable code and a human-readable message lets agents handle failures without guessing.

  • REST versioning / deprecation policyPartial (67%)

    API versioning found (URL versioning (servers or paths)) but no deprecation or sunset policy detected - add Sunset/Deprecation headers or a deprecation policy page

    Recommendation

    Declare a versioning policy agents can rely on: version your API (in the URL path or a version header) and publish how you signal deprecation (a Sunset/Deprecation header or a documented timeline). Agents avoid integrating against a surface that can change without warning.

  • CLI tool availablePartial (67%)

    CLI tool mentioned at https://brapi.dev/openapi.json

    Recommendation

    Publish an official CLI tool on npm, PyPI, or Homebrew. A CLI lets agents and developers script interactions with your product without building API integrations from scratch.

  • REST response schema coveragePassed

    100% of operations define typed response schemas, 100% use application/json

    Recommendation

    Define typed JSON response schemas for every endpoint in your OpenAPI spec. Agents rely on these to know what fields they will get back; missing or partial schemas force trial-and-error.

  • API schema complexity analysisPartial (50%)

    REST: schema found (76 operations) but partially documented

    Recommendation

    Make your API spec self-describing: a unique operationId and a description on every operation, typed parameters, and response schemas. For GraphQL, a fully typed schema with a documented cost or rate limit reads best.

  • Function calling compatibilityPassed

    Compatible: 76/76 ops with IDs, 76/76 with typed schemas

    Recommendation

    Ensure API endpoints have unique operation IDs, typed schemas, and descriptions compatible with LLM function-calling formats.

Bonus signals46 positive · +5 points
  • ARD / ai-catalogPassed

    ARD catalog valid (spec 1.0) - 2/2 entries, trustManifest present

    Recommendation

    Publish an Agentic Resource Discovery catalog at /.well-known/ai-catalog.json listing your agentic resources (MCP servers, agents, skills, APIs), each entry with a urn:air identifier, a media type, and exactly one of url or data. See https://agenticresourcediscovery.org/

  • ARD entry validityPassed

    All 2 entries valid with domain-anchored urn:air identifiers

    Recommendation

    Make every ai-catalog.json entry fully valid: a domain-anchored urn:air identifier, a displayName, a media type, and exactly one of url or data.

  • ARD trust manifestPassed

    trustManifest present on catalog entries (2/2 entries valid)

    Recommendation

    Add a trustManifest (verifiable identity, compliance attestations, or signature) to your ai-catalog.json entries so clients can verify your resources with progressive trust.

  • NPM/PyPI SDK packagePassed

    NPM package found: brapi - "The official TypeScript library for the Brapi API"

    Recommendation

    Publish a JavaScript/TypeScript SDK package on npm so developers can integrate your API programmatically. In package.json set repository to your source repo and homepage to your product domain - these links are how agents confirm the package is your official SDK rather than a third-party tool with a similar name.

  • Agent discovery filePassed

    Agent discovery file found at /agents.md

    Recommendation

    Publish an Agent Skills index at /.well-known/agent-skills/index.json that lists your capabilities, with each skill carrying a name and a description so agents can find and parse what you offer.

  • pricing.md existsPartial (50%)

    pricing.md found at /pricing.md but thin (52 lines) - add plan tiers, prices, and feature breakdowns

    Recommendation

    Create a /pricing.md file with your pricing tiers, features, and limits in plain markdown. This lets AI agents compare costs and recommend plans without scraping HTML pricing pages.

  • MCP well-known discoveryPassed

    MCP server discoverable via server-card.json at /.well-known/mcp/

    Recommendation

    Serve your MCP server at /.well-known/mcp, publish a server-card.json at /.well-known/mcp/server-card.json, or reference it in llms.txt so agents can discover it automatically without manual URL input.

  • Agent mode viewPassed

    Rich agent mode view at ?mode=agent with 5 agent signals and navigation links

    Recommendation

    Add a ?mode=agent query parameter to your homepage that returns a structured, machine-readable view with API endpoints, authentication info, and key capabilities instead of marketing HTML.

  • HTTP Link headers (RFC 8288)Passed

    RFC 8288 Link header advertises: sitemap, describedby, service-desc, api-catalog, alternate(markdown)

    Recommendation

    Add HTTP Link: response headers (RFC 8288) advertising your sitemap, markdown alternates, API service descriptions, and API catalog. Example: Link: </sitemap.xml>; rel="sitemap", </index.md>; rel="alternate"; type="text/markdown".

  • Markdown URL fallbackPassed

    Full markdown fallback support. Homepage (https://brapi.dev/index.md) and all 3 sampled content pages return markdown: https://brapi.dev/.well-known/api-catalog.md, https://brapi.dev/api/llms.txt.md, https://brapi.dev/docs.md

    Recommendation

    Let agents fetch markdown by appending .md to page URLs. Required for any credit: serve a markdown homepage at /index.md. For full credit (2/2): also serve a .md twin for each content page (e.g. /docs/auth -> /docs/auth.md). Content-Type should be text/markdown and the body should start with a top-level heading (not HTML).

  • Sitemap freshness (lastmod)Passed

    100% of 500 sampled sitemap entries carry lastmod; newest is 0 day(s) old

    Recommendation

    Add dates (W3C datetime, e.g. 2026-08-01) to your sitemap entries and update them when content actually changes. Aim for lastmod on at least half your entries with the newest within the last year. Verify with curl https://yourdomain.com/sitemap.xml | grep lastmod.

  • llms.txt existsPassed

    Found the llms.txt at https://brapi.dev/llms.txt.

    Recommendation

    Create an llms.txt file at your domain root (/llms.txt) - the AI equivalent of robots.txt. Write at least 100 characters of real content: what your product is, what it does, and links to your key docs. Then verify it with curl https://yourdomain.com/llms.txt - you should see your text, not HTML. If your app returns its homepage for every URL (common with single-page apps), add a static file route so the raw text is served. A placeholder with just a heading earns no credit.

  • llms.txt formattingPassed

    The llms.txt is well-formatted: 68 lines with markdown links, 5,087 characters in total.

    Recommendation

    Format your llms.txt as a navigation index: start with a markdown heading, include markdown links to deeper resources, and keep it under 30,000 characters. If you have more to say, move long-form content into /llms-full.txt or per-section files (e.g. /docs/llms.txt, /api/llms.txt) and link to them from the main index.

  • JSON-LD entity linking (sameAs)Passed

    Strong entity linking via sameAs: linkedin.com, github.com

    Recommendation

    Add sameAs links in your JSON-LD structured data pointing to your Wikipedia page, Wikidata entry, GitHub org, and social profiles. This helps AI disambiguate your brand from similarly named entities.

  • Speakable content markupPassed

    Speakable property found in JSON-LD - agents know which content to present conversationally

    Recommendation

    Add schema.org speakable markup to your homepage indicating which sections are suitable for AI assistant text-to-speech readout. Use a Speakable property with CSS selectors targeting your key value proposition.

  • Schema type breadthPartial (50%)

    Some extended schema types found: Service, FAQPage - add FAQPage, Service, or AggregateRating for full coverage

    Recommendation

    Expand your JSON-LD beyond Organization/WebSite. Add FAQPage for common questions, Service or Product for offerings, AggregateRating or Review for social proof, and BreadcrumbList for navigation context.

  • llms.txt links resolvePartial (50%)

    1 of 5 probed llms.txt links do not resolve: https://brapi.dev/api/llms.txt

    Recommendation

    Make every link your llms.txt declares resolve to real content. Verify each one with curl -L <url> - you should see the linked document, not your homepage. If your app returns the homepage shell for unknown paths (common with single-page apps), a 200 status is not proof: check the body. Fix or remove any dead link; agents that follow the index treat a broken link as a dead end.

  • Markdown alternate linkPassed

    Markdown alternate advertised and verified: https://brapi.dev/index.md serves markdown

    Recommendation

    Advertise a markdown twin of each page with in the HTML head (or an equivalent Link response header), and make sure the advertised URL actually serves markdown - an advertisement pointing at HTML is worse than none. Verify the target with curl -s <href> and check the body starts with a heading, not .

  • Markdown frontmatter metadataPassed

    Frontmatter with title + description, canonical, and last-updated on /llms.md

    Recommendation

    Open your served markdown docs with a --- frontmatter block carrying title plus at least one of description, canonical, or last-updated. Agents read frontmatter as document metadata without scraping. A Link: rel="canonical" response header also satisfies the canonical slot.

  • API catalog (RFC 9727)Passed

    RFC 9727 api-catalog with 2 API link(s) and rfc9727 profile

    Recommendation

    Publish an API catalog at /.well-known/api-catalog per RFC 9727. Serve it with Content-Type: application/linkset+json;profile="https://www.rfc-editor.org/info/rfc9727" and include a 'linkset' array with item entries pointing to your OpenAPI specs and service descriptions.

  • Markdown agent docsPassed

    Path-suffix markdown docs served with text/markdown content-type: /llms.md, /agents.md, /api.md, /developers.md, /auth.md, /index.md

    Recommendation

    Pick one: (a) return Content-Type: text/markdown on GET when the request sends Accept: text/markdown, or (b) publish a static /llms.md, /auth.md, or /agents.md file at your root with real markdown content. Option (b) is usually a single static file. This is the cold-discovery path for agents that land at your homepage from web search without reading llms.txt first.

  • Bot-UA markdown servingPassed

    https://brapi.dev serves markdown to the GPTBot User-Agent even with Accept: text/html - UA-sniffed agent responses in place

    Recommendation

    Optionally detect AI-bot User-Agents (GPTBot, ClaudeBot, PerplexityBot) server-side and serve them a markdown representation of the page directly, even when they send Accept: text/html. Verify with curl -A "ClaudeBot/1.0" https://yourdomain.com/ - a markdown body earns this bonus. Accept-header negotiation is scored separately.

  • MCP tool descriptionsPassed

    All 69 tools on product MCP have detailed descriptions (>= 20 chars)

    Recommendation

    Add detailed descriptions (>= 20 chars) to every MCP tool. Agents use these to decide which tool to call - vague descriptions lead to wrong tool selection.

  • MCP parameter schemasPassed

    69/69 tools on product MCP have parameter schemas, 44 with required fields

    Recommendation

    Define inputSchema with typed properties and required arrays for each tool. Agents need schema info to construct valid tool calls without guessing.

  • MCP server identityPassed

    product MCP identifies as "brapi-mcp-server" v1.0.0 with instructions

    Recommendation

    Set server name, version, and instructions in your MCP server's initialize response. Instructions help agents understand your server's purpose and constraints.

  • MCP tool listingPassed

    product MCP exposes 69 tools - substantial tool surface

    Recommendation

    Expose 3+ tools via your MCP server's tools/list endpoint. Cover your core API surface - agents need tools for read, write, and search operations.

  • MCP tool namingPassed

    All 69 tool names follow consistent convention, descriptive, and non-generic

    Recommendation

    Use consistent naming conventions (snake_case or camelCase) for all MCP tools. Names should be descriptive (>= 4 chars) and not generic (avoid 'run', 'get', 'do').

  • OAuth Protected Resource metadata (RFC 9728)Passed

    RFC 9728 metadata: resource=https://brapi.dev/api/mcp/mcp, authorization_servers (1), scopes_supported (1), bearer_methods_supported

    Recommendation

    Publish RFC 9728 protected-resource metadata at /.well-known/oauth-protected-resource. Include the resource field plus enough supporting metadata - your authorization servers, supported scopes, accepted bearer methods - that an agent can work out how to authenticate without first triggering a 401.

  • auth.md existsPassed

    auth.md at https://brapi.dev/auth.md served as text/markdown; charset=utf-8 (2058 chars)

    Recommendation

    Publish /auth.md as a markdown prose walkthrough of how agents should obtain credentials. Serve it with Content-Type: text/markdown, lead with a top-level heading, and write at least ~200 chars of real content (not just a placeholder). See the WorkOS auth.md draft at https://workos.com/auth-md.

  • auth.md structurePassed

    WorkOS auth.md structure at https://brapi.dev/auth.md - 7/7 walkthrough sections (found Discover, Pick a method, Register, Claim, Use credential, Errors, and Revocation); anchors: oauth-protected-resource, oauth-authorization-server, and register_uri

    Recommendation

    Structure /auth.md as the WorkOS spec prescribes: sections for Discover, Pick a method, Register, Claim, Use the credential, Errors, and Revocation, with spec anchor keywords (agent_auth, register_uri, identity_assertion, id-jag, WWW-Authenticate). Reference https://workos.com/auth-md.

  • auth.md walkthrough simulationPassed

    Static fallback (deep check disabled): PRM + AS metadata both reachable with agent_auth.register_uri (https://brapi.dev/oauth/register); walkthrough discoverable end-to-end

    Recommendation

    Make your published auth-discovery chain traversable end to end: an agent starting at /auth.md (or your protected-resource metadata) should be able to follow the links to your authorization-server metadata and registration endpoint without hitting a dead link. Test the whole path, not just each file in isolation.

  • Agent auth discovery metadataPassed

    PRM + AS metadata cross-linked; agent_auth has register_uri (https://brapi.dev/oauth/register), identity_types_supported [anonymous] with per-type *_supported blocks, and skill -> https://brapi.dev/auth.md

    Recommendation

    Publish RFC 9728 protected-resource metadata at /.well-known/oauth-protected-resource on your resource server (the host that actually serves the API, e.g. api.) with resource and authorization_servers. Publish RFC 8414 authorization-server metadata at /.well-known/oauth-authorization-server on the AS origin, and include the WorkOS auth.md agent_auth block with register_uri, identity_types_supported drawn from the spec enum (anonymous, identity_assertion - variants like verified_email or urn:ietf:params:oauth:token-type:id-jag belong inside identity_assertion.assertion_types_supported, not at the top level), and a sibling per-type block for each advertised type (anonymous.credential_types_supported; identity_assertion.assertion_types_supported + credential_types_supported) so agents can look up the request shape. Cross-link by listing the AS origin in PRM authorization_servers, and point agent_auth.skill back at your published /auth.md. Spec: https://workos.com/auth-md.

  • Agent auth WWW-Authenticate hintPassed

    401 at /api/mcp/mcp with spec-shaped WWW-Authenticate hint: Bearer resource_metadata="https://brapi.dev/.well-known/oauth-protected-resource/api/mcp/mcp", scope="mcp:read"

    Recommendation

    Return a 401 carrying a spec-shaped WWW-Authenticate: Bearer resource_metadata="<your protected-resource metadata URL>" header on your API's primary entry points, so an agent learns your auth requirements from one request instead of hunting for the well-known document. Point the metadata URL at /.well-known/oauth-protected-resource on the host that serves the API. Spec: https://workos.com/auth-md.

  • agent_auth endpoints reachablePassed

    agent_auth endpoints reachable (source: AS metadata agent_auth block) - register_uri: HTTP 204, claim_uri: not advertised, revocation_uri: not advertised

    Recommendation

    Make sure the URIs you advertise (in the AS metadata agent_auth block OR in your /auth.md prose) for register_uri, claim_uri, and revocation_uri actually resolve. An OPTIONS preflight should return any HTTP status (2xx/3xx/4xx that isn't 404). DNS-level failure or a 404 means the discovery block / prose is stale - either remove the URI or stand up the endpoint.

  • MCP error handlingPassed

    product MCP returns structured JSON-RPC errors with code and message

    Recommendation

    Return structured JSON-RPC errors (with code and message) when agents call invalid tools or pass bad arguments. Don't crash or return empty responses.

  • MCP modern transportPassed

    product MCP uses modern Streamable HTTP transport

    Recommendation

    Upgrade your MCP server from legacy SSE to Streamable HTTP transport. Streamable HTTP is the current standard and supports bidirectional communication.

  • REST pagination patternPartial (50%)

    Offset/page-based pagination found in OpenAPI spec - consider migrating to cursor-based pagination for agent friendliness

    Recommendation

    Use a consistent, documented pagination shape on your list endpoints (cursor-based preferred) and define the pagination fields in your OpenAPI response schemas, so agents can page through results without guessing the shape.

  • Multi-language SDK packagesPartial (67%)

    SDK packages found in npm, pypi

    Recommendation

    Publish official SDK packages across multiple language ecosystems (npm, PyPI, Go modules, RubyGems). Auto-generate them from your OpenAPI spec using tools like openapi-generator. For each package set the project URL or homepage to your product domain (package.json repository/homepage, PyPI Home-Page or project_urls, RubyGems homepage_uri) - this is how agents verify the package is your official SDK.

  • MCP tool annotationsPassed

    product MCP: 69/69 tools have behavioral annotations (readOnlyHint/destructiveHint)

    Recommendation

    Add behavioral annotations (readOnlyHint, destructiveHint) to your MCP tools. Agents use these to avoid destructive actions without user confirmation.

  • MCP server-card.jsonPartial (50%)

    MCP server card found at https://api.brapi.dev/.well-known/mcp/server-card.json but missing tools[]

    Recommendation

    Publish a server card at /.well-known/mcp/server-card.json describing your MCP server. Required fields: name, description, version, serverUrl, tools[]. This lets agents preview your server before opening a transport connection.

  • Product + docs MCP coveragePartial (50%)

    You run both MCP servers, but the documentation one (https://brapi.dev/docs/mcp) is not reachable. Fix it so agents can use it.

    Recommendation

    Beyond your product MCP server, expose a documentation MCP surface so agents can pull your docs and reference material over the same protocol they use to act. Covering both the 'do' and the 'learn' surfaces over MCP earns this.

  • Sandbox / test environmentPassed

    Sandbox environment found at https://brapi.dev/docs/sandbox

    Recommendation

    Provide a sandbox or test mode so agents can exercise your API without touching production data, and document how to reach it - this lowers the risk of a destructive call against live data.

  • Accessible document structurePassed

    Server HTML is a well-structured document (main=true, landmarks=4/4, h1=1, maxHeadingSkip=1).

  • Native interactive controlsPassed

    60 native controls, 0 non-native div-soup affordances (100% native).

  • Accessible names on controlsPassed

    60/60 interactive elements have a computable accessible name (100%).

  • Accessibility-tree injection safety (bonus)Passed

    No hidden instruction text detected in accessibility-tree attributes or off-screen content.

Inspect the underlying audit

The complete Ora audit uses evidence from the scan on . After applying changes, run another scan from the homepage to refresh these recommendations.

Sign me up for Vercel product updates and marketing emails.

Unsubscribe anytime. Privacy Notice

Source: Ora API

Snapshot 2026-08-21T22-51-18-792Z