Mintlifymintlify.com
Mintlify's API program shows real strengths in discovery and overall design, but partners and their AI agents face meaningful friction in three areas that matter most for production adoption: agents cannot reliably execute workflows due to missing runnable collections, idempotency guidance, and rate-limit signaling; there is no sandbox separation to de-risk early integration; and there are no AI-readable instructions to orient agents on how to use the API correctly. Fixing operational reliability, safe integration, and agent context should be the immediate priority, followed by closing the remaining onboarding and example gaps to ensure partners can go from discovery to working integration without friction.
API DesignA clean, typed, well-governed API contract agents can reason about2 pass2 warn1 fail82A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Auth declared & discoverablevia spec | 25/25 | Authentication required (global or on every operation). Investigated: spec 100%, docs 100%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| warn | Machine-readable, versioned contractvia spec | 21.3/25 | info.version="1.0.0" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 85%, docs 70%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia spec | 17.5/25 | Only 50% of operations have documented schemas. Investigated: spec 70%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| fail | Example coveragevia spec | 0/10 | 0% example coverage. Investigated: spec 0%, docs 0%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples4 pass0 warn1 fail85A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Signup page at https://app.mintlify.com/signup; no free-tier language detected in docs/pricing. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://www.mintlify.com/docs/quickstart with a runnable first-call sample. Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Description completenessvia spec | 15/15 | 50% description completeness. Investigated: spec 100%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog documented in the docs site at https://www.mintlify.com/docs/changelog. Investigated: spec 100%, docs 100%. | A published changelog lets partners track changes without surprise. |
| fail | Code samples in docsvia docs | 0/18 | No detectable code samples across 1 sampled docs pages. Investigated: docs 0%. | Multi-language samples shorten time-to-first-call. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs3 pass1 warn0 fail98A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Docs reachable, not hard auth-gatedvia docs | 30/30 | All 50 sampled pages are publicly accessible. Investigated: docs 100%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| warn | llms.txt present, valid & comprehensivevia docs | 28.1/30 | llms.txt directive found in HTML of 49 of 50 sampled pages (1 missing). Investigated: docs 94%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (mintlify/docs, 2652 snippets). Investigated: docs 100%, sdk 50%, cli 0%, mcp 0%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| pass | Crawlable / AEOvia wellknown | 12/12 | Docs paths crawlable by all monitored AI agents. Investigated: wellknown 100%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs2 pass3 warn1 fail70B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | Only 2 distinct 4xx/5xx codes documented (plus 0 "default" catch-all responses). Investigated: docs 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| warn | Agent-navigable, token-efficient docsvia docs | 19.8/22 | 2 of 49 pages have substantive content differences between markdown and HTML (avg 3% missing). Investigated: docs 90%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| pass | Docs structured datavia docs | 8/8 | JSON-LD Article markup on 1/1 assessed pages (100%) with dateModified present. Investigated: docs 100%. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| warn | Operation purpose clarityvia spec | 5/25 | 0% of operations are agent-inferable. Investigated: spec 20%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Description consistency across surfaces | 2.7/7 | Mean pairwise description similarity across 2 surfaces (spec, docs) is 14% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| fail | Agent instructions file (AGENTS.md)via wellknown | 0/10 | No AGENTS.md at the site root or /.well-known/. Investigated: wellknown 0%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them0 pass0 warn4 fail40F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| fail | Idempotency documentedvia spec | 0/27 | 0% of mutating operations document idempotency. Investigated: spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| fail | Rate-limit signalingvia spec | 0/22 | No rate-limit response headers documented. Investigated: spec 0%, docs 0%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| fail | Sandbox separationvia spec | 0/20 | No sandbox/test server declared across 1 server entries; no test-key prefixes documented. Investigated: spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
| fail | Runnable collection with test scriptsvia platform | 0/9 | No public Postman workspace discovered for the org. Investigated: platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| na | Pagination documented & consistent | —/22 | No surface produced evidence for this capability in this run. | Consistent, documented pagination lets agents traverse collections. |
Resources Discovered
The public resources we found for Mintlify — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (2,652) |
|---|---|
| APIs analyzed | 5 — Mintlify Admin API, Mintlify Analytics Export API, Mintlify Assistant API, Mintlify External API, Mintlify Static Export API |