work_comment_list
List comments on a work item (oldest first).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| work_id | Yes | Work item UUID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
List comments on a work item (oldest first).
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| work_id | Yes | Work item UUID |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the disclosure burden. It states the read-only nature ('List') and the ordering ('oldest first'), which is useful. It does not disclose pagination/limit behavior or whether the listing is flat or hierarchical, though the output schema and limit parameter partially cover operational details.
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?
The description is a single compact sentence that front-loads the core action, names the resource, and adds the key ordering detail. Every word earns its place with no redundancy.
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 simple read-only list tool with one required parameter and an output schema, the description plus schema is nearly sufficient. It identifies the target resource, the ordering, and the only required input. A small gap is the lack of any mention of pagination behavior beyond the schema's limit field.
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 50%: work_id is described as 'Work item UUID', while limit only has type/range/default constraints. The description adds little beyond the schema, tying the action to 'a work item', but the limit parameter's purpose is reasonably inferable from its name and constraints. No severe gap.
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 uses a specific verb and resource: 'List comments on a work item'. It also adds the meaningful ordering detail '(oldest first)', and it is clearly distinguishable from siblings like work_comment_add (creating comments) and work_list (listing work items).
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 intended use is obvious: call this when you need the comments attached to a work item. However, the description gives no explicit when/when-not guidance and does not point to alternatives such as work_comment_add for adding comments or work_get for retrieving the work item itself.
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.