Skip to main content
Glama

work_comment_add

Add a comment to a work item. Result includes org + bound.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesComment text (markdown ok)
agentNoOverride agent identity
work_idYesWork item UUID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It only hints at the result format ('org' + 'bound') but does not explain what these mean, nor does it mention permissions, idempotency, or side effects. The verb 'Add' implies a mutation, but the description does not explicitly confirm write behavior or its consequences.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact—two sentences—with no filler. The first sentence clearly states the action. The second sentence about result is concise but cryptic, slightly reducing clarity without adding bulk. Overall, it is efficient, though the result note could be phrased more meaningfully.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a simple operation (3 params, 2 required) with 100% schema coverage, so the description need not elaborate on parameters. An output schema exists (not shown but flagged), which likely explains return fields, reducing the need for description detail. However, the cryptic 'org' and 'bound' reference is a gap—if the output schema does not clarify it, agents may be confused. The description is adequate for a low-complexity tool but not fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema already documents all three parameters (work_id, body, agent) with descriptions. The tool description adds no parameter-specific information; it only mentions 'org' and 'bound' in the result, which is not about parameters. Per the baseline, a 3 is appropriate given full schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a clear action: 'Add a comment to a work item.' It specifies the verb (add) and resource (work item), which is unambiguous. However, it does not differentiate from sibling tools like work_comment_list, and the cryptic 'Result includes ``org`` + ``bound``' adds confusion rather than clarity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus alternatives. The natural sibling is work_comment_list, but the description never mentions it, nor any conditions, prerequisites, or exclusions. An agent is left to infer that this tool is for adding, not listing, comments.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.