Get a quote
servicetrade_get_quoteGet one quote by id with status, line items and totals. ServiceTrade API: GET /quote/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The quote id. |
servicetrade_get_quoteGet one quote by id with status, line items and totals. ServiceTrade API: GET /quote/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The quote id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already covers safety, so the description's added value is the disclosure of return contents (status, line items, totals), which matters because no output schema exists. It stops short of noting 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 and return contents front-loaded. The trailing API route reference is mildly redundant but harmless for an agent mapping to endpoint context.
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-param read tool with annotations and no output schema, the definition covers what the tool returns and its scope. Only failure behavior for a nonexistent id is left unspecified.
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?
There is a single parameter with 100% schema coverage ('The quote id.'), so the schema carries the semantics. The description restates 'by id' without adding format, source, or lookup guidance, matching the baseline of 3.
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 quote by id') and previews the payload ('status, line items and totals'), which separates it from servicetrade_list_quotes. It does not explicitly name the list sibling, so it falls just short of a 5.
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?
Usage is only implied: 'by id' signals it is the lookup-once variant versus the list tools. There is no explicit when-to-use, when-not-to-use, or named alternative.
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.