Get an appointment
servicetrade_get_appointmentGet one appointment by id with window, technicians and job. ServiceTrade API: GET /appointment/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The appointment id. |
servicetrade_get_appointmentGet one appointment by id with window, technicians and job. ServiceTrade API: GET /appointment/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The appointment 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 the underlying REST endpoint and the shape of returned data (window, technicians, job), which is useful context, but says nothing about not-found behavior or embedded object depth.
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, front-loaded with the operation and followed by the endpoint mapping. No filler.
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 one-parameter read tool with no output schema, the description supplies the key detail an agent needs—what the returned appointment contains. It stops short of describing the response envelope or error cases, but is largely sufficient.
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 100% and the single id parameter is fully documented in the schema, so the description's 'by id' adds nothing new. Baseline 3 is appropriate.
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 (get) and resource (one appointment by id) and even enumerates what the record includes (window, technicians, job). The phrase 'one appointment by id' cleanly separates it from the sibling servicetrade_list_appointments.
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?
Implicit usage is clear: fetch a single appointment when you already have its id, versus listing. But no alternative is named and no when-not guidance (e.g., 'use list_appointments to find an id first') 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.