get_checkout
Get a checkout by id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| meta | No | UCP request metadata, e.g. {"ucp-agent": {"profile": "<agent profile URL>"}}. Optional here. |
Get a checkout by id.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| meta | No | UCP request metadata, e.g. {"ucp-agent": {"profile": "<agent profile URL>"}}. Optional here. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already declares this is a safe read operation, and the description is consistent with that. However, the description adds no behavioral context beyond the annotation—no mention of error behavior for missing checkouts, authentication needs, or what a checkout object represents.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The definition is a single front-loaded sentence with no wasted words. Its brevity is efficient, though the same terseness contributes to gaps in behavioral and usage guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-by-id tool with a readOnlyHint and a partially documented schema, the description is minimally adequate. However, with no output schema and no description of the returned checkout structure or common failure modes, it leaves meaningful context gaps for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50%: the 'id' parameter lacks a schema description while 'meta' is documented. The phrase 'by id' partially compensates by clarifying that the id identifies a checkout, but it gives no format or validation details for that required parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Get a checkout by id.' This clearly distinguishes retrieval from sibling mutations like create_checkout, update_checkout, cancel_checkout, and complete_checkout. It does not explicitly name or differentiate against those siblings, but the verb/resource pairing is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as lookup_catalog or search_catalog, nor any exclusions or prerequisites. The only usage signal is the implied retrieval-by-id operation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.