Skip to main content
Glama

edit_comment

Add a review comment (or reply) to a question or block, edit its text, or mark it resolved or unresolved. delete_comment removes one.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "survey_id": "<survey_id>"
    },
    "name": "edit_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
updateNoReplace the text of one of your own comments.
resolveNoMark a comment thread resolved.
add_blockNoAdd a comment, or a reply, on a block.
survey_idYesSurvey UUID (for read-back context)
unresolveNoReopen a resolved comment thread.
add_questionNoAdd a comment, or a reply, on a question.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the mutation profile is known. The description adds the resolution-state behavior (resolve/unresolve as reversible actions), which is useful, but it says nothing about the author-only edit restriction, reply-to-reply thread collapsing, or failure modes — those live only in the schema.

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 waste: the primary capabilities are front-loaded and the single alternative is named last. Nothing is repeated from the schema or annotations.

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?

Given an output schema and fully described nested parameters, the description covers what the tool does and the one adjacent tool to avoid. It stops short of mentioning authorship constraints on edits, but that complexity is already documented in the schema.

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%, including character limits, UUID sourcing, and thread-collapsing rules for parent_comment_id, so the schema does the heavy lifting. The description adds no parameter-level meaning beyond naming the operations, which is the correct baseline of 3.

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 specific verbs tied to the resource: 'add a review comment (or reply)', 'edit its text', 'mark it resolved or unresolved'. It also names the sibling it is not ('delete_comment removes one'), so an agent can separate creation/editing/resolution from deletion without opening a schema.

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 clearly frames the three usage modes (add, edit, resolve/unresolve) and routes deletions to delete_comment. The per-mode selection guidance is carried by the nested schema objects rather than the description itself, and it states no prerequisites or exclusions beyond the delete alternative.

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.

Resources