Camundacamunda.com
Camunda's API program shows strong foundations in API design and agent discoverability, but two areas need urgent attention before partners and their AI agents can confidently build against it. Agent usability is the most critical gap: without runnable examples, rate-limit signaling, or consistent pagination, partners face guesswork at every integration step — and AI coding agents are likely to hallucinate or stall.
API DesignA clean, typed, well-governed API contract agents can reason about3 pass2 warn0 fail93A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Schema coverage & depthvia sdk | 25/25 | 86/86 (100%) public params are fully typed (no any/**kwargs). Analyzer confirms all methods have a derivable input schema. Investigated: sdk 100%, spec 52%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| 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 | Auth declared & discoverablevia docs | 21.3/25 | No securitySchemes declared. Investigated: docs 85%, spec 43%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| 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. |
| pass | Example coveragevia spec | 10/10 | No parameters or responses available to score example coverage. Investigated: spec 100%, docs 100%, sdk 100%. | 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 fail79B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Self-service signup at https://docs.camunda.io/build-with-camunda/; free tier / sandbox documented. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Code samples in docsvia docs | 18/18 | Code samples in 5 language(s) across docs (top: shell, javascript, typescript); 1/6 pages have ≥ 2 languages on the same page. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | 74% description completeness (target 90%+). Investigated: spec 100%, sdk 39%. | 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://docs.camunda.io/llms-reference.txt. Investigated: spec 100%, docs 100%, sdk 100%. | A published changelog lets partners track changes without surprise. |
| fail | Quickstart presentvia docs | 0/25 | No quickstart/getting-started page found at the conventional paths. Investigated: docs 0%. | A quickstart is the fastest path from landing page to first successful call. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs1 pass3 warn0 fail87A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/camunda_manual_7_24, 7904 snippets). Investigated: docs 100%, cli 100%, sdk 58%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | llms.txt present, valid & comprehensivevia docs | 25/30 | No /llms-full.txt found at the candidate origins. Investigated: docs 83%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Docs reachable, not hard auth-gatedvia docs | 22.5/30 | Server ignores Accept: text/markdown header (0/2 pages return markdown). Investigated: docs 75%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| warn | Crawlable / AEOvia wellknown | 9/12 | Sitemap present (3214 entries) but carries no lastmod values. Investigated: wellknown 75%. | 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 docs1 pass2 warn2 fail79B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | No 4xx/5xx response codes (or default error response) documented anywhere in the spec. Investigated: docs 100%, spec 58%, sdk 0%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| warn | Operation purpose clarityvia spec | 22.5/25 | 76% of operations are agent-inferable (target 90%+). Investigated: spec 90%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Agent-navigable, token-efficient docsvia docs | 18.7/22 | 2 of 2 pages have substantive content differences between markdown and HTML (avg 54% missing). Investigated: docs 85%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| 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. |
| fail | Docs structured datavia docs | 0/8 | Neither JSON-LD nor OpenGraph/meta tags detected across 3 assessed pages (3 JS-rendered). Investigated: docs 0%. | 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. |
| na | Description consistency across surfaces | —/7 | Only 0 surface description(s) with ≥6 tokens available; need at least 2 to compare. | Every surface tells the same story about what the product is. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them1 pass1 warn3 fail54D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia sdk | 27/27 | Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| warn | Sandbox separationvia sdk | 10/20 | No test-mode flag or sandbox environment is exposed. Investigated: sdk 50%, spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations 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 | Pagination documented & consistentvia spec | 0/22 | 1 list endpoint(s) exist but no pagination params found. Investigated: spec 0%, docs 0%. | Consistent, documented pagination lets agents traverse collections. |
| 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. |
Resources Discovered
The public resources we found for Camunda — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (7,904) |
|---|---|
| APIs analyzed | 10 — Orchestration Cluster API, Orchestration Cluster API (REST), Camunda Hub API (SaaS), Camunda Hub API (Self-Managed), Web Modeler Public API (REST), (Deprecated) Operate Public API (SaaS), (Deprecated) Operate Public API (Self-Managed), Optimize Public API, (Deprecated) Tasklist Public API (REST), API documentation reference |