UPSups.com
UPS's API design foundation is solid, and agent understanding is largely strong — but the partner program has critical gaps in discoverability, onboarding, and operational reliability that will block both human partners and AI agents before they ever make a first call. The highest priorities are establishing a self-service front door with machine-readable discovery signals, and documenting the operational contracts (idempotency, rate-limiting, and change history) that agents and integrators depend on to build trustworthy workflows.
API DesignA clean, typed, well-governed API contract agents can reason about2 pass3 warn0 fail78B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Schema coverage & depthvia spec | 19.6/25 | Only 50% of operations have documented schemas. Investigated: spec 78%, sdk 25%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| warn | Machine-readable, versioned contractvia spec | 16.3/25 | No info.version and no versioning scheme detected. Investigated: spec 65%, docs 30%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| 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. |
| warn | Auth declared & discoverablevia docs | 12.5/25 | No securitySchemes declared. Investigated: docs 50%, spec 25%, wellknown 0%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| pass | Example coveragevia spec | 10/10 | 0% example coverage. Investigated: spec 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 examples0 pass1 warn2 fail44F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Description completenessvia sdk | 9/15 | 6/15 operations lack a description. Investigated: sdk 60%, spec 0%. | Complete descriptions are the context humans and agents need to use endpoints. |
| fail | Self-service developer portalvia docs | 0/29 | No signup page detected across conventional paths (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free). Investigated: docs 0%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| fail | Changelog publishedvia spec | 0/13 | No changelog URL or mention found in spec metadata. Investigated: spec 0%, docs 0%, sdk 0%. | A published changelog lets partners track changes without surprise. |
| na | Quickstart present | —/25 | No surface produced evidence for this capability in this run. | A quickstart is the fastest path from landing page to first successful call. |
| na | Code samples in docs | —/18 | No surface produced evidence for this capability in this run. | Multi-language samples shorten time-to-first-call. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs1 pass0 warn2 fail55D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/developer_ups, 51856 snippets). Investigated: docs 100%, sdk 50%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| fail | llms.txt present, valid & comprehensivevia docs | 0/30 | No /llms-full.txt found at the candidate origins. Investigated: docs 0%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| fail | Crawlable / AEOvia wellknown | 0/12 | No sitemap discoverable via robots.txt or /sitemap.xml on the docs host. Investigated: wellknown 0%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| na | Docs reachable, not hard auth-gated | —/30 | No surface produced evidence for this capability in this run. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs1 pass1 warn1 fail81A
| 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 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| warn | Operation purpose clarityvia spec | 21.3/25 | 0% of operations are agent-inferable. Investigated: spec 85%. | 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. |
| na | Agent-navigable, token-efficient docs | —/22 | No surface produced evidence for this capability in this run. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| na | Docs structured data | —/8 | No surface produced evidence for this capability in this run. | 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 1 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 them0 pass2 warn2 fail45F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| 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. |
| 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. |
| 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. |
| 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 UPS — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (51,856) |
|---|---|
| APIs analyzed | 10 — UPS Forwarding, UPS TrackService API, Address Validation - Street Level, Rate, UPS Customs Detail, UPS Track Alert, OAuth Client Credentials API, UPS Delivery Intercept, UPS DeliveryDefense Address Confidence, UPS Export Assure Interactive Description of Goods |