Skip to main content
Glama

Update Note

update_note
DestructiveIdempotent

Use only when the user wants to rewrite or correct a note in place — replaces its title and/or content wholesale. To add to a note without losing what is there, use append_note instead. Addressed by the id from list_notes. Fails cleanly if the note is set to read-only for AI assistants.

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": "update_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe note id to update
titleNoNew note title
contentNoNew note content

Output Schema

NameRequiredDescriptionDefault
idYes
titleYes
sourceYes
contentYes
created_atYes
updated_atYes
agent_accessYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/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 adds value beyond them: it spells out that replacement is wholesale (so prior text is lost), that the id comes from list_notes, and that the call fails cleanly when the note is AI read-only. The remaining gap is whether omitting title or content leaves that field untouched or clears it — a material ambiguity for a destructive 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?

Three short sentences, front-loaded with the usage constraint, followed by the sibling exclusion and then the provenance/failure note. No filler and no repetition of the title or schema text.

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?

Strong coverage for a 3-parameter mutation: when to use, which alternative to pick, id provenance, and the read-only failure path, with an output schema handling return values. Only the partial-update semantics are left unstated, which is a modest but real omission given destructiveHint=true.

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 the baseline would be 3; the description still adds meaning by telling the agent the id originates from list_notes and that title and content act independently ("and/or"). It does not resolve the omit-vs-clear question, which is the one parameter behavior an agent most needs.

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 or correct a note in place") and immediately pins down the semantics: title and/or content are replaced wholesale, not merged. This distinguishes it cleanly from a pure-read or create operation without needing the 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 says when to use it ("only when the user wants to rewrite or correct a note in place") and names the alternative with its selecting condition ("To add to a note without losing what is there, use append_note instead"). The "only" is a real exclusion, not a soft hint.

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.