Skip to main content
Glama

edit_comment

Edits a comment's text (max 4096 characters). Only the comment's own author can edit it - check canManage in list_issue_comments before calling.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYesThe comment's new text, replacing what's there now, max 4096 characters.
commentIdYesThe comment's id, from list_issue_comments.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / text / description
      Previous value: -"The comment's new text, replacing what's there now."New value: +"The comment's new text, replacing what's there now, max 4096 characters."
    • addedInput schema / properties / text / maxLength
      Added value: +4096
  2. Changed1 schema field changed
    • changedInput schema / properties / commentId / description
      Previous value: -"The comment's id, from get_issue's comment list."New value: +"The comment's id, from list_issue_comments."
  3. Changed1 schema field changed
    • changedInput schema / properties / commentId / description
      Previous value: -"The id of the comment to edit, from get_issue's comment list."New value: +"The comment's id, from get_issue's comment list."
  4. First observed

TDQS

A3.8/5.0
Behavior3/5

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

No annotations exist, so the description carries the full behavioral burden. It does disclose a real permission constraint (author-only) and the length cap, which is meaningful. It omits what happens on rejection, whether the prior text is recoverable, and what a successful call returns.

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 sentences, zero filler, and the action is front-loaded ahead of the constraint and the permission caveat.

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 two-parameter edit with no output schema and no annotations, the description covers what is edited, the limit, and the authorization gate. Only the success/failure outcome is left unstated, which is minor.

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%, and both parameters are documented in the schema itself, so the baseline is 3. The description restates the 4096 limit already present in the schema and only hints at where commentId comes from.

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?

States a specific verb and resource ('Edits a comment's text') with a scope constraint (max 4096 characters). It is clearly distinguishable from edit_issue or create_comment by resource, though it never explicitly contrasts itself with those siblings.

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

Usage Guidelines4/5

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

Gives a concrete precondition: only the comment's own author can edit it, and it routes the agent to list_issue_comments / canManage to verify that before calling. No explicit when-not or alternative-tool guidance beyond that, but the usage condition is actionable.

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.