Skip to main content
Glama

edit_comment

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

Input Schema

NameRequiredDescriptionDefault
textYesThe comment's new text, replacing what's there now, max 4096 characters.
filesNoFiles to attach, base64-encoded - each becomes a new attachment, in addition to the comment's existing ones. Same format as create_issue.
commentIdYesThe comment's id, from list_issue_comments.
removeAttachmentIdsNoIds of the comment's attachments to remove, from list_issue_comments. Can be combined with files to replace one attachment with another.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / files
      Added value: +{
      +  "default": null,
      +  "description": "Files to attach, base64-encoded - each becomes a new attachment, in addition to the comment's existing ones. Same format as create_issue.",
      +  "items": {
      +    "properties": {
      +      "base64Content": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "contentType": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "fileName": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "fileName",
      +      "contentType",
      +      "base64Content"
      +    ],
      +    "type": [
      +      "object",
      +      "null"
      +    ]
      +  },
      +  "type": [
      +    "array",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / removeAttachmentIds
      Added value: +{
      +  "default": null,
      +  "description": "Ids of the comment's attachments to remove, from list_issue_comments. Can be combined with files to replace one attachment with another.",
      +  "items": {
      +    "format": "uuid",
      +    "type": "string"
      +  },
      +  "type": [
      +    "array",
      +    "null"
      +  ]
      +}
  2. 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
  3. 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."
  4. 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."
  5. First observed

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral disclosure burden. It adds the important author-only permission constraint, but does not state whether edits are reversible, what happens to existing text beyond replacement, or how attachment removal behaves.

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 the core action and the critical authorization prerequisite front-loaded. There is no wasted language.

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 mutation tool with no output schema, the description covers the essential precondition and the main effect. It could say more about replacement/removal side effects, but the schema supplies the detailed parameter semantics.

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 schema already explains all four parameters in detail. The description adds only the max-length reminder and loosely mentions optional attachments, which is baseline value when the schema does the heavy lifting.

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 uses a specific verb and resource: it edits a comment's text and optionally its attachments. It clearly distinguishes this from sibling tools like create_comment and delete_comment.

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?

It gives a clear precondition: only the comment's author can edit, and the caller should check canManage in list_issue_comments first. It does not explicitly compare against alternatives beyond that prerequisite.

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.