Skip to main content
Glama

editComment

DestructiveIdempotent

Rewrite a comment you previously left on a Jam, so an agent can correct or extend its own note instead of stacking a follow-up comment. Takes the comment ID returned by createComment. The new body replaces the old one entirely and is Markdown. You can only edit comments you authored. Changes are visible to people who can access the Jam, including public viewers when sharing permits it.

Input Schema

NameRequiredDescriptionDefault
bodyYesThe replacement comment body in Markdown format. Replaces the existing body entirely. At most 2000 characters.
intentNoIn 15-30 English words, your larger task and why this call helps it. People by role ("a customer"); no argument values or secrets.
commentIdYesComment identifier — the `id` returned by createComment, or a comment deep link carrying `?commentId=`
llm_modelNoYour exact model id from your system prompt, or "unknown". Never guess.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / body / description
      Previous value: -"The replacement comment body in Markdown format. Replaces the existing body entirely."New value: +"The replacement comment body in Markdown format. Replaces the existing body entirely. At most 2000 characters."
    • changedInput schema / properties / intent / description
      Previous value: -"In 15-30 words, say what larger task you are working on and why this tool helps it. Refer to people and companies by role (\"a customer\"), and leave out argument values and secrets. Use English. Example: \"Debugging a checkout failure a customer reported, checking which network request returned the 500.\""New value: +"In 15-30 English words, your larger task and why this call helps it. People by role (\"a customer\"); no argument values or secrets."
    • changedInput schema / properties / llm_model / description
      Previous value: -"The exact model identifier you are running as, from your system prompt or environment (e.g. \"claude-opus-4-8\", \"gpt-5.2\"). Pass \"unknown\" if you are not certain; never guess."New value: +"Your exact model id from your system prompt, or \"unknown\". Never guess."
  2. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and idempotentHint=true, and the description earns credit by specifying exactly what is destroyed: "The new body replaces the old one entirely." It further discloses the authorization requirement (author-only), the content format (Markdown), and the visibility consequence to other users including public viewers.

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

Conciseness4/5

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

Four sentences, front-loaded with the core action and rationale, and each carries distinct information (purpose, input lineage, replacement semantics, permissions/visibility). Slightly redundant that both the description and the schema state the body fully replaces the old one.

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 critical unknowns: what is overwritten, who may call it, and who sees the result. It does not mention failure modes (invalid commentId, non-authored comment) or what the tool returns on success, a minor gap given the operation's simplicity.

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 commentId, body, intent, and llm_model are already documented in the schema. The description only restates that commentId comes from createComment and that body is Markdown replacement text, adding no syntax or edge-case detail beyond the structured fields. Baseline 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?

States a specific verb and resource ("Rewrite a comment you previously left on a Jam") plus scope (own comments only), which separates it cleanly from createComment and deleteComment in the sibling list. The parenthetical purpose ("correct or extend its own note instead of stacking a follow-up comment") makes the distinction unmistakable.

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 clear when-to-use guidance: correct or extend an existing note rather than posting a follow-up. It also states a hard eligibility constraint ("You can only edit comments you authored"). It never explicitly names createComment or deleteComment as the alternative for other cases, so the routing is implied rather than spelled out.

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.