Siemenssiemens.com
Siemens' API program shows strong fundamentals in API design — the contract is clean, typed, and machine-readable, which is a solid foundation for partner and agent integrations. However, the program has two critical gaps holding it back: agents and coding assistants cannot reliably discover, parse, or act on the documentation (missing structured signals, agent instruction files, and idempotency guidance), and partners face a slow, friction-heavy path to a first working call with no quickstart or code samples.
API DesignA clean, typed, well-governed API contract agents can reason about3 pass2 warn0 fail93A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Auth declared & discoverablevia docs | 25/25 | Authentication required (global or on every operation). Investigated: docs 100%, spec 60%, wellknown 50%. | 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 sdk | 20.8/25 | 0/1 (0%) enum-like params are realized as constrained types (not bare strings). Investigated: sdk 83%, spec 60%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Security & governance hygienevia wellknown | 15/15 | security.txt valid at https://siemens.com/.well-known/security.txt (Contact + unexpired Expires). Investigated: wellknown 100%, spec 90%. | 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 | 0% example coverage. Investigated: spec 100%, sdk 100%, 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 examples3 pass0 warn2 fail66C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Signup page at https://www.siemens.com/en-us/products/tia-portal/eigen-engineering-agent/; 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 | Description completenessvia spec | 15/15 | 55% description completeness. Investigated: spec 100%, sdk 0%. | 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://keepachangelog.com/en/1.0.0/. 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. |
| fail | Code samples in docsvia docs | 0/18 | No detectable code samples across 6 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 docs2 pass2 warn0 fail78B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (siemens/element, 2796 snippets). Investigated: docs 100%, sdk 67%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | Docs reachable, not hard auth-gatedvia docs | 22.5/30 | Server ignores Accept: text/markdown header (0/16 sampled pages return markdown). Investigated: docs 75%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| 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. |
| warn | llms.txt present, valid & comprehensivevia docs | 11.3/30 | No llms.txt directive found in HTML of any of 49 sampled pages; 1 failed to fetch. Investigated: docs 38%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs2 pass2 warn2 fail74B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | Only 1 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. |
| pass | Operation purpose clarityvia spec | 25/25 | 100% of operations have a clear summary + operationId an agent can select on. Investigated: spec 100%. | 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 | 14.3/22 | 2 of 6 pages have substantive content differences between markdown and HTML (avg 26% missing). Investigated: docs 65%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Description consistency across surfaces | 0.6/7 | Mean pairwise description similarity across 2 surfaces (spec, docs) is 3% (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. |
| 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. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them0 pass4 warn1 fail49F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Pagination documented & consistentvia spec | 12.2/22 | No pagination on list endpoints. Investigated: spec 56%, docs 56%. | Consistent, documented pagination lets agents traverse collections. |
| 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. |
| warn | Runnable collection with test scriptsvia platform | 4.5/9 | No test scripts found in the workspace's collections. Investigated: platform 50%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| warn | Rate-limit signalingvia spec | 1.1/22 | No rate-limit response headers documented. Investigated: spec 5%, docs 5%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| fail | Idempotency documentedvia spec | 0/27 | 0% of mutating operations document idempotency. Investigated: spec 0%, docs 0%, sdk 0%. | Documented idempotency lets agents retry safely. |
Resources Discovered
The public resources we found for Siemens — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (2,796) |
|---|---|
| APIs analyzed | 10 — Polarion REST API, Industrial Edge, DepotFinity, Tecnomatix, Assetfox, Enlighted, Battery Passport, Walkinside, SIMATIC PCS neo in the Cloud, COMOS |