Skip to main content
Glama
Miles1994

siyuan-note-mcp

by Miles1994

Update block

update_block

Replace an existing block's content with new Markdown, optionally locking the block type. Retrieve the block ID first using get_block or search_notes.

Instructions

Replace the content of an existing block with new Markdown. The block type may change (e.g. a paragraph into a heading) unless lock_type is true. Get the ID from get_block or search_notes first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesBlock ID to replace.
dataYesNew Markdown content for the block.
lock_typeNoWhen true, refuse the update if the parsed block type differs from the original.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses that the block type can change and that lock_type guards against that, which is real mutation semantics. It stops short of stating permissions required, reversibility, or what a failed update returns.

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 core action, then the type-change caveat, then the ID-sourcing prerequisite. No filler.

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 an unannotated mutation tool with no output schema, the description covers purpose, the type-change behavior, the lock_type safety path, and where to get the ID. Missing only side details like permission requirements and error semantics, which is a minor 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%, so the schema already documents all three parameters, including lock_type's refusal behavior. The description reframes lock_type behaviorally ('unless lock_type is true') but adds no syntax or format detail beyond the schema, so baseline 3 applies.

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 ('Replace the content of an existing block with new Markdown'), making the mutation contract immediately clear. It is cleanly distinguishable from insert_block, delete_block, and get_block, which appear as siblings.

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?

Explicitly gives the prerequisite for obtaining the required id ('Get the ID from get_block or search_notes first'), naming the alternative tools. It does not, however, state when to choose this over insert_block or when an update is inappropriate.

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