◎ Discry Score
knock.com
communication · API
A
0 / 100
DISCOVERY0
COMPREHENSION0
Category leader: 98 (A)
Discry your API →
COMMUNICATION · RANK #2 OF 24

Knock is Agent-Ready to agents.

Discry independently scored how well an AI agent can discover and understand the Knock API from what’s public — not whether it’s usable. Below: every signal we checked, what’s costing the score, and what to change.

Discry your API — freeView the docs ↗

SCORED UNDER RUBRIC 1.2 · A full re-launch under Discry Score 2.5 — a new behavioral instrument, not comparable to these scores — is in progress.

Discovery

45% of score · 88/100
OpenAPI specA machine-readable OpenAPI/Swagger spec agents can parse.Pass
llms.txtAn llms.txt index that points agents to the docs that matter.Pass
llms.txt qualityThe llms.txt is focused, current, and well under the size budget.Partial
llms-full.txtA full-text bundle agents can load in one request.Pass
AGENTS.mdAn AGENTS.md that tells coding agents how to build on the API.Pass
.well-known/mcp.jsonA discoverable MCP manifest at a well-known path.Fail
MCP registryThe API is listed in a public MCP registry.Partial
robots.txt AI directivesrobots.txt allows (or explicitly guides) AI crawlers.Pass
SitemapA sitemap so agents can enumerate the docs surface.Pass

Comprehension

55% of score · 96/100
Task-oriented descriptionsEndpoints described by what they accomplish, not just their shape.Pass
Realistic examplesRunnable, real-world request/response examples.Pass
Multi-step workflowsDocs that chain calls into complete jobs an agent can follow.Pass
Error-recovery guidanceDocumented failure modes and how to recover from them.Pass
Answer-first formatThe answer leads; preamble does not bury it.Pass
Capability boundariesClear limits — what the API can and cannot do.Pass
Naming consistencyConsistent, predictable naming across endpoints.Pass
Heading hierarchyClean heading structure agents can navigate.Pass
Markdown docsDocs available as clean markdown, not JS-rendered HTML only.Pass
Token efficiencyDocs are concise enough to fit an agent context window.Partial

What we found

  • An agent looking for Knock would find a near-complete agent-readiness toolkit: a 76KB structured llms.txt, a 2.1MB llms-full.txt, per-page markdown (.md) versions, AGENTS.md files in primary repos, and a dedicated knocklabs/skills repo of packaged skills built explicitly for AI coding agents — Knock has deliberately invested in machine consumers.
  • An agent could integrate without trial-and-error: docs ship multi-language, copy-pasteable code examples (Node, Python, Ruby, Java) with task-titled snippets, plus explicit error-recovery guidance (back off on 429, configurable SDK retries, idempotent replay) — the self-correction signals that separate agent-usable docs from human-only docs.
  • Knock operates an official MCP server and Agent Toolkit, and publishes its API via OpenAPI (Stainless-generated, with publicly accessible specs split by API surface) — an agent can both discover the tools and consume a typed contract.
  • robots.txt allows all crawlers, the sitemap indexes every API/AI/CLI page, and capability boundaries (rate limits, batch limits, data retention, MJML/partial limitations, key-length validation) are documented — an agent discovers limits by reading, not by failing.
  • The only material gap is breadth-driven token efficiency: the platform spans workflows, broadcasts, guides, channels, objects, preferences and more, so fully grasping the API surface costs well above 5K tokens despite a clean overview; .well-known/mcp.json is also absent (404).

What to change

Prioritized by impact on discoverability. You (or your docs platform) deploy these — Discry never touches your API.

  1. 01Add a /.well-known/mcp.json manifest declaring the official MCP server's tools and auth so agents can auto-discover the server without reading prose docs (quick win, the server already exists).
  2. 02Publish the canonical OpenAPI spec at a stable, vendor-hosted URL (e.g. docs.knock.app/openapi.yml) and link it prominently from the API reference, rather than relying on third-party mirrors — gives agents a first-party typed contract.
  3. 03Submit the Knock MCP server to the major registries (Glama, Smithery, PulseMCP) so agents browsing those indexes discover it — currently no clear registry listing surfaces in search.
  4. 04Trim or split the 76KB llms.txt into a lean capability-overview index (<50KB) that points to llms-full.txt for depth, improving right-sized agent consumption.
  5. 05Add a concise 'Core API in 5 minutes' overview that lets an agent grasp the full resource model (workflows, broadcasts, guides, recipients, channels) in under 5K tokens before diving into individual concept pages.

Execution coverage · INFORMATIONAL, UNSCORED

Whether an agent can actually complete a call and recover from errors is the deeper Audit layer — documented here, but not part of the Discry Score.

API key (secret key)JWT user tokens (client-side, signed)Enhanced security mode (signed tokens) Error format documented Rate limits documented Pagination documented Idempotency documented

Exceptionally complete execution documentation: secret-key + signed-JWT auth, machine-parseable errors surfaced as typed SDK exceptions (RateLimitError, APIStatusError, APIConnectionError), documented rate limits including a separate batch rate-limit section, cursor-based pagination, and detailed idempotency-key semantics (255-char keys, replay window, success-only recording).

See your own Discry Score.

Drop your API docs URL. See what an agent sees — in 60 seconds, free.

Discry your API — free