Get a work order
ezrentout_get_work_orderOne work order by number. GET /tasks/<Work_Order#>.api.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| work_order_number | Yes | The work order number. |
ezrentout_get_work_orderOne work order by number. GET /tasks/<Work_Order#>.api.
| Name | Required | Description | Default |
|---|---|---|---|
| work_order_number | Yes | The work order number. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already declares the safety profile, so the description owes added context: what happens for an unknown work order number, whether soft-deleted/closed work orders are returned, or any pagination/expansion behavior. Instead it only restates the HTTP endpoint (GET /tasks/<Work_Order#>.api), which adds no decision-useful information for an agent.
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 fragments, front-loaded with the core purpose. The endpoint path in the second sentence is questionable value but costs little space.
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?
A one-parameter read-only lookup with full schema coverage and no output schema is nearly self-explanatory; annotations cover safety. Only the not-found/closed-record behavior is left unstated, which is a minor gap for a tool this simple.
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% and the single parameter already documents 'The work order number' with an integer-or-numeric-string pattern. The description adds nothing beyond 'by number', so the baseline 3 applies.
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 fragment 'One work order by number' states both the verb (retrieve exactly one) and the resource (work order), and the singular 'One' implicitly distinguishes it from list_work_orders and the sibling create/complete/start work-order tools. It is terse but an agent can tell what the tool returns 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 when-to-use statement, no prerequisites, and no named alternative. The agent must infer from 'One ... by number' that this is the single-record lookup versus list_work_orders. That inference is easy but not stated.
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.