Skip to main content
Glama

Edit a post

note_update

Edit an existing noticeboard post by updating its status, pin, kind, or text; send only changed fields and pass expectedUpdatedAt to avoid conflicting edits.

Instructions

Edits an existing noticeboard post: resolve or reopen it, pin or unpin it, change its kind, or rewrite its text. Send only the fields you want to change. content, pinned and kind may only be changed by the post author or an admin (otherwise 403 not_owner); content only on manually written posts (otherwise 403 content_locked). status may only be changed by the author, an admin, or a member who has set a take reaction on the post (otherwise 403 status_change_not_allowed). Resolving a post pushes a notification to the author and the takers. Pass expectedUpdatedAt to guard against concurrent edits: if the post changed meanwhile the call fails with 409 announcement_changed, so read notes_list again before retrying. To remove a post use note_delete; to take it on use note_react.

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>"
    },
    "name": "note_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesId of the post to change, from notes_list.
kindNoNew type of the post. Omit to leave unchanged.
pinnedNotrue pins the post to the top of the board, false unpins it. Omit to leave unchanged.
statusNoSet resolved to close the post or open to reopen it. Omit to leave unchanged.
wgCodeNoShare code of the flat (code from wg_list). Leave it out when the account belongs to one flat.
contentNoNew text, replacing the old text completely. Omit to leave unchanged.
expectedUpdatedAtNoThe updatedAt of this post as last read from notes_list (ISO 8601 with offset). If the post changed since, the update is rejected with announcement_changed. Omit to skip the check.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.1.1
    • addedInput schema / properties / content / description
      Added value: +"New text, replacing the old text completely. Omit to leave unchanged."
    • addedInput schema / properties / expectedUpdatedAt / description
      Added value: +"The updatedAt of this post as last read from notes_list (ISO 8601 with offset). If the post changed since, the update is rejected with announcement_changed. Omit to skip the check."
    • addedInput schema / properties / id / description
      Added value: +"Id of the post to change, from notes_list."
    • addedInput schema / properties / kind / description
      Added value: +"New type of the post. Omit to leave unchanged."
    • addedInput schema / properties / pinned / description
      Added value: +"true pins the post to the top of the board, false unpins it. Omit to leave unchanged."
    • addedInput schema / properties / status / description
      Added value: +"Set resolved to close the post or open to reopen it. Omit to leave unchanged."
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Goes well past the supplied annotations, which say only readOnly=false, idempotent=false, destructive=false. The description names the exact authorization rules per field group and the resulting 403 codes, discloses the side effect of resolving a post (notification to author and takers), and documents the optimistic-concurrency failure mode with a 409 code and a recovery instruction. Minor gap: it does not say what the successful response looks like, but there is no output schema for it to defer to.

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?

Front-loads the core action, then the partial-update rule, then the per-field constraints, then concurrency, then the sibling pointers. Dense but every sentence carries a distinct fact. Compression is heavy in the permission sentences ("content, pinned and kind may only be changed by..."), which costs a little legibility.

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?

Covers all the complexity this mutation tool carries: 7 parameters, multiple permission tiers, a side-effecting state transition, concurrency guarding, and error recovery. With no output schema, it still gives the agent enough to call it and handle the realistic failure paths.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so most of the field-level meaning is already structured. The description adds semantics the schema does not carry: which parameter groups are author/admin-gated versus reaction-gated, that content only applies to manually written posts, and the exact 409 code produced when expectedUpdatedAt is stale, along with the instruction to re-read notes_list before retrying.

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?

Opens with a specific verb and resource ("Edits an existing noticeboard post") and then enumerates the concrete operations it supports: resolve/reopen, pin/unpin, change kind, rewrite text. An agent can distinguish it from note_delete and note_react without opening either schema.

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 elsewhere: "To remove a post use note_delete; to take it on use note_react," which names the alternative and the condition that selects it. It also states the partial-update contract ("Send only the fields you want to change"), which the schema cannot imply on its own.

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