Get a payment
get_paymentFetch a single payment by id. OwnerRez API: GET /v2/payments/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The payment id. |
get_paymentFetch a single payment by id. OwnerRez API: GET /v2/payments/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The payment id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already tells the agent this is a safe read. The description adds only the underlying API mapping (GET /v2/payments/{id}); it says nothing about 404/not-found behavior, auth requirements, or what the response contains, so it adds modest value beyond annotations.
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?
Two short sentences, zero filler, with the core action front-loaded before the API reference. Every clause earns its place.
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 single-resource read with annotations covering safety and a fully documented one-param schema, this is nearly sufficient. Since no output schema exists, a brief note on what a payment record returns or the not-found case would have closed the remaining gap.
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 coverage is 100% for the single id parameter ('The payment id.'), so the schema already does the work. The description's 'by id' adds no format, type, or range detail beyond it, making 3 the correct baseline.
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?
States a specific verb ('Fetch'), resource ('payment'), and scope ('a single payment by id'), which cleanly separates it from list_payments among the siblings. An agent can identify the operation without opening the schema.
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 explicit when-to-use or when-not guidance and no routing to alternatives such as list_payments when the id is unknown. Usage is only inferable from the required id parameter.
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.