Get a deficiency
servicetrade_get_deficiencyGet one deficiency by id with severity, status, asset and reporting job. ServiceTrade API: GET /deficiency/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The deficiency id. |
servicetrade_get_deficiencyGet one deficiency by id with severity, status, asset and reporting job. ServiceTrade API: GET /deficiency/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The deficiency id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds useful context by naming the salient fields returned and disclosing the underlying endpoint (GET /deficiency/{id}), but says nothing about behavior for a missing or invalid id.
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 compact sentences with the core purpose front-loaded and no filler; the endpoint reference is a cheap addition rather than padding.
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-parameter read tool with a covered safety annotation and no output schema, the description does enough: it names the fields an agent will get back and identifies the endpoint. Only error/not-found behavior is unaddressed.
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 id parameter is fully documented in the schema, so baseline 3 applies. The description's 'by id' adds nothing beyond what the schema already states.
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 and resource ('Get one deficiency by id') and enumerates the notable returned fields (severity, status, asset, reporting job). The word 'one' implicitly separates it from servicetrade_list_deficiencies, though the sibling is never named.
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?
The phrase 'by id' implies the caller must already possess a deficiency id, which hints that list_deficiencies is the discovery step, but this is left to inference. No explicit when-to-use or when-not guidance is given.
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.