Skip to main content
Glama
johnsarie27

joplin-mcp

by johnsarie27

Update Note Section

update_note_section

Replace one exact, unique substring inside a Joplin note while leaving the rest untouched. It writes nothing if the text is missing or matches multiple times, keeping edits safe.

Instructions

Replace an exact, unique substring within a note's body, without touching the rest of the note. Fails with no write if old_str isn't found, or if it matches more than once - use get_note to find a longer, unique old_str in that case.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
new_strYes
note_idYes
old_strYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.5.0

TDQS

A4.5/5.0
Behavior5/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 and delivers: it discloses atomic failure semantics ('Fails with no write'), the uniqueness constraint, both failure triggers, and the recovery path. This is unusually thorough behavioral disclosure 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with the core operation front-loaded and failure behavior second. No filler, though a lead sentence naming the tool's uniqueness constraint could make it even more scannable.

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?

Output schema exists so return values needn't be explained. The description covers purpose, failure modes, and recovery, which is sufficient for a 3-param mutating tool. Minor gap around deletion semantics aside, nothing critical is missing.

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 description coverage is 0%, so the description must compensate; it explains old_str semantics ('exact, unique substring') and that new_str replaces it, implying note_id selects the note. It doesn't spell out that empty new_str should be used for pure deletion, leaving a small gap.

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 resource ('Replace an exact, unique substring within a note's body') and delimits scope ('without touching the rest of the note'). This is clearly distinguishable from siblings append_note_section and update_note.

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?

Explains failure conditions and points to get_note as the remedy when old_str is non-unique, effectively routing to the right sibling. It doesn't state when to prefer update_note vs append_note_section, but the context is clear enough.

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