Get work order comment
get_work_order_commentGet a single work order comment by ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Work order comment ID |
get_work_order_commentGet a single work order comment by ID.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Work order comment 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, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds only that it returns a single record, contributing marginal behavioral value beyond the 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?
A single, front-loaded sentence with no wasted words and the scoping detail ('single', 'by ID') placed early. It is efficient, though extremely terse even for a simple get.
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 whose annotations cover the safety profile, the description is minimally sufficient. With no output schema, it omits any hint of what a returned comment contains or what happens on a missing/invalid ID, leaving a modest 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?
With a single parameter at 100% schema description coverage, the schema already documents 'id' as a UUID work order comment ID. The description restates 'by ID' without adding format, lookup, or error semantics, so 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?
States a specific verb+resource ('Get a single work order comment') and scopes it to one record by ID, which implicitly separates it from list_work_order_comments. However, it never explicitly names the list/update/delete siblings that share the same resource, so the differentiation is inferred rather than stated.
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 implied by 'single ... by ID' (fetch one record when you have its ID), but there is no explicit when-to-use or when-not guidance and no reference to list_work_order_comments as the alternative for multiple comments. Adequate but leaves routing to inference.
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.