Smarthrsmarthr.jp
Smarthr's API program shows strength in basic contract structure, but agent understanding and agent usability are critically underdeveloped — partners and their AI agents cannot reliably parse errors, understand operation intent, or run safe end-to-end workflows. The most urgent priorities are making the API surface interpretable and executable for agents (structured error semantics, operation clarity, and runnable examples), then closing the discoverability and onboarding gaps that slow every new partner's first integration.
API DesignA clean, typed, well-governed API contract agents can reason about1 pass2 warn2 fail61C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Machine-readable, versioned contractvia spec | 18.8/25 | info.version="0.0.1" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 75%, docs 50%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia spec | 16.7/25 | 92% of operations have documented schemas (target 95%+). Investigated: spec 67%, sdk 0%. | 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 100%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| fail | Auth declared & discoverablevia spec | 0/25 | No securitySchemes declared. Investigated: spec 0%, docs 0%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| fail | Example coveragevia spec | 0/10 | 0% example coverage. Investigated: spec 0%, docs 0%, sdk 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 examples2 pass0 warn3 fail56D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Self-service signup at https://smarthr.jp/signup/; free tier / sandbox documented. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Changelog publishedvia sdk | 13/13 | Newest official SDK activity 0 day(s) ago. Investigated: sdk 100%, spec 0%, docs 0%. | 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 1 sampled docs pages. Investigated: docs 0%. | Multi-language samples shorten time-to-first-call. |
| fail | Description completenessvia spec | 0/15 | 32% description completeness. Investigated: spec 0%. | Complete descriptions are the context humans and agents need to use endpoints. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs1 pass2 warn1 fail65C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/support_smarthr_jp_ja, 1420 snippets). Investigated: docs 100%, sdk 75%, 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/1 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 | 6/12 | No sitemap discoverable via robots.txt or /sitemap.xml on the docs host. Investigated: wellknown 50%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| fail | llms.txt present, valid & comprehensivevia docs | 0/30 | No llms.txt found at any candidate location (https://developer.smarthr.jp/llms.txt, https://developer.smarthr.jp/docs/llms.txt). Investigated: docs 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 docs0 pass1 warn4 fail45F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Agent-navigable, token-efficient docsvia docs | 17.3/22 | No pages support .md URLs (0/1 tested). Investigated: docs 79%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| fail | Machine-readable errors (RFC 9457)via spec | 0/28 | No 4xx/5xx response codes (or default error response) documented anywhere in the spec. Investigated: spec 0%, docs 0%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| fail | Operation purpose clarityvia spec | 0/25 | 8% of operations are agent-inferable. Investigated: spec 0%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| 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 1 assessed pages (1 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 pass0 warn4 fail46F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Pagination documented & consistentvia spec | 22/22 | Pagination params detected on 26 list endpoint(s). Investigated: spec 100%, docs 100%. | Consistent, documented pagination lets agents traverse collections. |
| 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. |
Resources Discovered
The public resources we found for Smarthr — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (1,420) |
|---|---|
| APIs analyzed | 1 — SmartHR API |