Skip to main content
Glama

Update a note

update_note
Destructive

Changes a note's markdown. mode "append" adds text on a new line at the end; mode "replace" makes the note the given markdown. Edits merge live with people typing in the note: a replace built from an earlier read keeps the edits made since that read, and writes nothing when they touch the same lines as the replace. Needs edit access; encrypted notes are refused.

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>",
      "markdown": "<markdown>",
      "mode": "<mode>"
    },
    "name": "update_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe id at the end of the link, e.g. "k3v9qa" in https://static.md/md/k3v9qa
modeYes"append" adds to the end; "replace" rewrites the whole note, keeping edits made after base_version
markdownYesMarkdown to append, or the complete new note for "replace"
base_versionNoFor "replace": the version of the note the markdown was built from, as read_note or this tool's last answer gave it. Edits made after it are kept; if they touch the same lines, nothing is written. Default: the version this connection last read.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / base_version
      Added value: +{
      +  "description": "For \"replace\": the version of the note the markdown was built from, as read_note or this tool's last answer gave it. Edits made after it are kept; if they touch the same lines, nothing is written. Default: the version this connection last read.",
      +  "maxLength": 64,
      +  "type": "string"
      +}
    • changedInput schema / properties / mode / description
      Previous value: -"\"append\" adds to the end; \"replace\" overwrites the whole note"New value: +"\"append\" adds to the end; \"replace\" rewrites the whole note, keeping edits made after base_version"
  2. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Beyond the annotations (which only declare destructive/non-idempotent), it discloses the live-merge semantics: a replace built from an earlier read preserves concurrent edits and writes nothing when the same lines are touched. It also discloses the authorization requirement and that encrypted notes are refused. That is exactly the behavioral detail the agent cannot get from structured fields.

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?

Purpose is front-loaded and every sentence carries operational meaning (modes, merge behavior, permissions). The final clause about same-line conflicts is densely packed and takes a second read, but nothing is wasted.

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 destructive, non-idempotent mutation with no output schema, the description covers when writes are dropped, who can call it, and what is refused — enough to call it correctly. It could say more about what comes back (e.g. a new version usable as base_version), which would close the last gap.

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 coverage is 100% and already documents id, mode, markdown, and base_version including the default. The description restates mode behavior and adds conflict semantics but no syntax or format guidance beyond the schema. Baseline 3 is appropriate 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.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Changes a note's markdown" is a specific verb+resource, and the two modes (append vs replace) are spelled out so the agent knows exactly which mutation shape it is invoking. It does not name a sibling explicitly, but the encrypted-notes refusal implicitly points encrypted content at write_note_ciphertext.

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?

The description defines when to pick each mode ("append" adds a line at the end, "replace" makes the note the given markdown) and states the precondition of edit access. It stops short of routing the agent to alternatives such as create_note or write_note_ciphertext for other situations.

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