Skip to main content
Glama

update_note

Overwrite an existing note with new content to rewrite or restructure it. Replaces the entire file with new text.

Instructions

Overwrite an existing note with new content.

Use when rewriting or restructuring a note. For adding content without losing existing text, use append_to_note instead.

Args: path: Relative path from vault root, e.g. 'decisions/my-decision.md' content: Full new content to write (replaces the entire file)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
contentYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It clearly discloses the destructive overwrite behavior and even the exact parameter semantics, but it does not mention permissions, whether backups occur, or the return format. A 4 reflects strong disclosure of the core destructive trait with minor gaps.

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?

Two sentences of prose plus a focused Args section. The destructive nature is front-loaded, and every line serves a purpose without redundancy.

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 two-parameter, destructive write tool with no annotations but an existing output schema, the description covers the operation, the destructive semantics, parameter usage, and the alternative tool. Nothing essential is missing for correct agent invocation.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must compensate. It provides an example for path ('decisions/my-decision.md') and explicitly states that content replaces the entire file, which is critical for correct invocation. This fully compensates for the absent schema descriptions.

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?

The description states a specific verb (overwrite) and resource (note), and immediately differentiates from the sibling append_to_note by naming the destructive vs. additive behavior. An agent can distinguish update_note from append_to_note without inspecting schemas.

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 states when to use (rewriting or restructuring) and when not to (adding content without losing existing text), naming the alternative (append_to_note). This is textbook when/when-not/alternative guidance.

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