◎ Discry Score
dreamfactorysoftware.com
infrastructure · API
B
0 / 100
DISCOVERY0
COMPREHENSION0
Category leader: 98 (A)
Discry your API →
INFRASTRUCTURE · RANK #22 OF 68

dreamfactorysoftware is Good to agents.

Discry independently scored how well an AI agent can discover and understand the dreamfactorysoftware 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 · 60/100
OpenAPI specA machine-readable OpenAPI/Swagger spec agents can parse.Partial
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.Pass
llms-full.txtA full-text bundle agents can load in one request.Fail
AGENTS.mdAn AGENTS.md that tells coding agents how to build on the API.Fail
.well-known/mcp.jsonA discoverable MCP manifest at a well-known path.Fail
MCP registryThe API is listed in a public MCP registry.Pass
robots.txt AI directivesrobots.txt allows (or explicitly guides) AI crawlers.Pass
SitemapA sitemap so agents can enumerate the docs surface.Partial

Comprehension

55% of score · 100/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.Pass

What we found

  • An agent evaluating DreamFactory finds a genuinely rare asset: a hand-authored llms.txt (updated 2025-09-18) that opens with a canonical TL;DR, explicit 'how LLMs should use this file' instructions, a source-of-truth link map, and copy-ready REST query patterns — it can answer most questions without scraping a single page.
  • The documentation itself is best-in-class for comprehension: clean Docusaurus markdown, Quick Reference tables at the top of every page (answer-first), realistic example values (emp_no 10001, 'Georgi Facello'), consistent snake_case, and end-to-end workflows (generate → secure → query → sync) rather than isolated endpoints. Comprehension scored a perfect 100.
  • Discovery is what holds the grade back: no AGENTS.md in the primary repo, no llms-full.txt, and no /.well-known/mcp.json — so a coding agent cloning the repo or probing standard agent-discovery paths gets nothing beyond the README.
  • The www sitemap.xml lists marketing and 'hub' pages but omits the entire docs.dreamfactory.com documentation tree (a separate subdomain), so an agent crawling the main sitemap to find API docs would miss all of them and have to rely on the llms.txt link map instead.
  • DreamFactory ships an official MCP server listed on PulseMCP and Glama — an agent looking to call DreamFactory-generated APIs natively can discover a governed, RBAC-enforced tool surface, a strong signal most scanned APIs lack.

What to change

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

  1. 01Add an AGENTS.md to the primary github.com/dreamfactorysoftware/dreamfactory repo (highest-weight discovery gap at weight 3): document how a coding agent should install, configure services, and call generated endpoints. This is the single biggest available score lift.
  2. 02Publish a static, publicly accessible OpenAPI 3.x spec for the platform's own system APIs (db, user, system, files) — today the Swagger/OpenAPI docs only exist inside a running instance, so an agent can't retrieve a spec without standing up DreamFactory first.
  3. 03Add the docs.dreamfactory.com documentation URLs to a sitemap the crawler will find (either extend the www sitemap or ensure the docs subdomain's own sitemap is linked from robots.txt) so agents crawling sitemaps reach the API reference.
  4. 04Serve /.well-known/mcp.json advertising the official DreamFactory MCP server and its tool declarations, turning an already-published capability into a machine-discoverable one at the standard path.
  5. 05Generate an llms-full.txt that inlines the core database-API, auth, and querying docs as markdown, so agents get a single comprehensive payload without following links to individual Docusaurus 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 (X-DreamFactory-Api-Key header)JWT session token (X-DreamFactory-Session-Token header)OAuth 2.0SAML 2.0OpenID ConnectLDAP / Active DirectoryBasic Authentication Error format documented Rate limits documented Pagination documented Idempotency documented

Execution characteristics are exceptionally well documented for a generated-API platform. Errors return machine-parseable JSON ({"error": {code, context, message}}); auth spans API key + JWT plus five SSO/identity protocols with identity passthrough; pagination is limit/offset with include_count. Rate limiting is documented as a commercial-tier feature (configurable) but specific default limits and header names aren't published. Idempotency keys are not mentioned, though PUT (full replace) vs PATCH (partial) semantics are clearly distinguished.

See your own Discry Score.

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

Discry your API — free