Skip to main content
Glama

Edit your own comment

note_comment_update

Replace the text of your own noticeboard comment without notifying anyone; only the comment author can edit it.

Instructions

Replaces the text of one of your own comments on a noticeboard post; nobody is notified. Only the comment author may edit it, not even an admin (403 not_owner); an unknown comment returns 404 comment_not_found. To remove a comment use note_comment_delete; to add a new one use note_comment.

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": {
      "id": "<id>",
      "commentId": "<commentId>",
      "content": "<content>"
    },
    "name": "note_comment_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesId of the post the comment belongs to, from notes_list.
wgCodeNoShare code of the flat (code from wg_list). Leave it out when the account belongs to one flat.
contentYesNew text, replacing the old text completely.
commentIdYesId of the comment to edit, from note_comments or notes_list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.1
    • addedInput schema / properties / commentId / description
      Added value: +"Id of the comment to edit, from note_comments or notes_list."
    • addedInput schema / properties / content / description
      Added value: +"New text, replacing the old text completely."
    • addedInput schema / properties / id / description
      Added value: +"Id of the post the comment belongs to, from notes_list."
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations only say readOnly=false, destructive=false, idempotent=false; the description adds real behavioral context beyond that — no notifications are sent, only the author may edit (403 not_owner), and unknown comments yield 404 comment_not_found. It does not address whether the edit updates a timestamp or how the replaced text is returned, which is the only remaining gap for a mutation tool.

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?

A single dense sentence that front-loads the core action and scope, then appends the side-effect, error semantics, and sibling routing. Every clause carries information an agent would otherwise have to discover at runtime.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 4-parameter mutation with full schema coverage and no output schema, the description covers scope, side effects, authorization failure mode, and not-found behavior. An agent has everything needed to select and invoke it correctly.

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%, with each of the four parameters already documented (id from notes_list, wgCode from wg_list, commentId from note_comments/notes_list, content as a full replacement up to 600 chars). The description adds no parameter-level detail beyond that, so the 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 precise verb and scope: "Replaces the text of one of your own comments on a noticeboard post." The ownership qualifier ("your own") and the resource (comment on a noticeboard post) distinguish it immediately from note_comment, note_comment_delete, and note_update.

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

Usage Guidelines5/5

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

Explicitly routes the agent to alternatives: use note_comment_delete to remove a comment and note_comment to add one, leaving edit as the only remaining action. It also states the precondition (author-only, admins excluded), so the agent can pre-check eligibility rather than discovering it via a 403.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.