Skip to content

ng.guide

Ready with a few material gaps

What should the prompt cover?

9 findings · 5 selected

Failures (7)

Warnings (2)

Task

What does ng.guide do and who is it for? Explain it back to me.

Waiting for the agent’s first step…

Agents can access the public site

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.

    2 / 2 passed
  • Navigation fails safely

    Redirects and missing pages give agents a recoverable path.

    2 / 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

Strong

89%

16 of 18 mature checks passed

API

Needs work

50%

4 of 8 mature checks passed

Authentication

Needs work

50%

1 of 3 mature checks passed

MCP

Blocked

33%

0 of 1 mature checks passed

Fix these gaps first

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

  1. 01

    OpenAPI spec published

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

    Other readiness checks
  2. 02

    Scoped permissions

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

    Other readiness checks
  3. 03

    JSON error responses

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

    Other readiness checks
  4. 04

    Markdown content negotiation (acceptmarkdown.com)

    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.

    Other readiness checks
  5. 05

    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

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.

Essential7 of 11 passed · 50.9 / 80 points
  • Content without JavaScriptPassed

    6460 chars, semantic headings (H1 + 5 H2s + 9 H3s), 6.1% content ratio

    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 publishedFailed

    No OpenAPI/Swagger specification found

    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)Failed

    Not acceptmarkdown.com compliant: Accept: text/markdown returned text/html; charset=utf-8; Vary header missing Accept (got "rsc, next-router-state-tree, next-router-prefetch, next-router-segment-prefetch")

    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://ng.guide (issuer=https://ng.guide/api/auth)

    Recommendation

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

  • Scoped permissionsFailed

    No scoped permissions or security schemes found

    Recommendation

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

  • JSON error responsesFailed

    API does not return JSON error responses (or no API detected)

    Recommendation

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

  • Agent-friendly 404sPassed

    Nonexistent paths return HTTP 404 with markdown guidance for agents - the strongest 404 contract

    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.

Recommended14 of 19 passed · 15.6 / 20 points
  • Developer resource discoverabilityFailed

    Agent searched for "ng.guide" 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 discoverabilityPassed

    ng.guide appears at position #1 in a clean brand-name search for "ngguide" (1 total match)

    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://ng.guide/sitemap.xml with 22 entries

    Recommendation

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

  • Content efficiencyPassed

    Content efficiency: 6.40% (6756 text chars / 103KB HTML)

    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: Organization with name, description, url, and sameAs/logo/address (2 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="en", 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 6 measured pages fit an agent context budget (largest ~3K 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 1 markdown document

    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://ng.guide/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: free tier available, 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 (33%)

    MCP mentioned on site but no standard manifest endpoint found

    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.

  • CLI tool availablePassed

    CLI package found on npm: ng-cli

    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.

  • API schema complexity analysisFailed

    No API schema detected

    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 compatibilityFailed

    No API spec found - function calling requires discoverable endpoints

    Recommendation

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

Bonus signals17 positive · +3.7 points
  • NPM/PyPI SDK packagePassed

    NPM package found: @ng-select/ng-option-highlight - "```shell npm install --save @ng-select/ng-option-highlight ```"

    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 platform configsPassed

    Agent config found: github.com/ngguide/ui/blob/main/CLAUDE.md

    Recommendation

    Add an AGENTS.md or .cursorrules file to your public GitHub repo with instructions for how AI coding agents should interact with your codebase. Then make sure the repo is documented in the entry-point pages agents read - homepage, docs, and llms.txt - so it can be discovered without guessing.

  • pricing.md existsPassed

    Structured pricing.md found at /pricing.md (35 lines)

    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 referenced in llms.txt

    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.

  • llms.txt existsPassed

    Found the llms.txt at https://ng.guide/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: 28 lines with markdown links, 3,410 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)Partial (50%)

    Entity linking to github.com - add more authority profiles (Wikipedia, Wikidata, LinkedIn, GitHub)

    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.

  • Schema type breadthPartial (50%)

    Some extended schema types found: 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 resolvePassed

    All 5 probed llms.txt links resolve to real content

    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.

  • OAuth Protected Resource metadata (RFC 9728)Passed

    RFC 9728 metadata: resource=https://ng.guide, authorization_servers (1)

    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.

  • Agent auth discovery metadataPartial (33%)

    PRM + AS metadata both present but AS metadata has no agent_auth block

    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 /mcp/angular-ui-kit with spec-shaped WWW-Authenticate hint: Bearer error="invalid_token", error_description="No authorization provided", resource_metadata="https://ng.guide/.well-k

    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.

  • Multi-language SDK packagesPartial (33%)

    SDK package found only in npm

    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.

  • Accessible document structurePassed

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

  • Native interactive controlsPassed

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

  • Accessible names on controlsPassed

    38/38 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-21T23-13-23-047Z