Skip to main content
Glama

Comment on an issue

add_comment

Post a markdown comment on an issue, optionally as a reply to another comment. Returns the comment url.

Input Schema

NameRequiredDescriptionDefault
bodyYesMarkdown body of the comment.
issueYesAn issue identifier like "ENG-42", or an issue id.
replyToNoId of the comment being replied to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare mutation (readOnlyHint=false), non-idempotency, and non-destructiveness, so the safety profile is covered. The description adds genuine value beyond that: the body is markdown, replies are supported via threading, and the call returns the comment URL. It omits whether posting triggers notifications or requires issue-write access, which keeps it short of a 5.

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?

Two compact sentences with zero filler; the core action is front-loaded and the return value is appended last. Nothing could be removed without losing information.

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 three-parameter mutation with full schema coverage, the definition covers the action, the optional reply path, and the return value. The only gap is behavioral context around side effects such as notifications, which is minor for this tool's complexity.

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 each parameter is already documented in the schema, which sets the baseline at 3. The description confirms the markdown nature of body and the optional reply behavior but adds no format or identifier syntax beyond what the schema states.

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 names a specific verb and resource ("Post a markdown comment on an issue") and adds a scope qualifier ("optionally as a reply to another comment"). This distinguishes it from comment_on_doc, edit_comment, and delete_comment without the agent needing to open another schema.

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

Usage Guidelines3/5

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

Usage is implied by the tool name and siblings (use edit_comment/delete_comment for other operations), and the reply case is flagged via "optionally as a reply." However, there is no explicit statement of when to use this versus edit_comment, nor any prerequisite or exclusion guidance.

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.