Skip to main content
Glama

add_comment

Adds a comment to an issue and returns the new comment's id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYesThe comment's text.
issueKeyYesThe issue's key, e.g. 'BRD-42'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It does state the mutation effect ('adds') and the return value (new comment id), which is helpful. However, it does not disclose permission requirements, error behavior, or any side effects beyond the basic action, leaving a moderate gap for a write operation.

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

Conciseness5/5

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

The description is a single, front-loaded sentence with no wasted words. It states the action, the target, and the return value efficiently, earning every word.

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

Completeness4/5

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

For a simple 2-parameter tool with full schema coverage and no output schema, the description is largely complete. It covers the return value, which is the only behavioral output an agent needs. It lacks explicit sibling routing, but that gap is already accounted for in usage_guidelines and does not significantly undermine safe invocation in this context.

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%, with both issueKey and text already well-defined. The description adds no parameter-specific detail beyond what the schema provides, so the baseline score of 3 applies.

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

Purpose5/5

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

The description states a specific verb and resource ('Adds a comment to an issue') and adds the return outcome ('returns the new comment's id'). It clearly distinguishes from siblings like edit_comment (add vs. edit) and create_issue (comment vs. issue) without needing to open their schemas.

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?

The description provides no explicit guidance on when to use this tool versus alternatives. It does not mention edit_comment or any condition that would select add_comment over other siblings. Usage is only implied by the verb 'adds', which is insufficient for clear decision-making.

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.