Skip to main content
Glama
Miles1994

siyuan-note-mcp

by Miles1994

Create document

create_document

Create a Markdown document at a specified path, auto-creating missing parent documents. If the path exists, a new document is added alongside without overwriting the original.

Instructions

Create a document from Markdown. path is the human-readable path, e.g. /Notes/Idea; missing parent documents are created automatically. An existing path is not overwritten — a new document is created alongside it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesDocument path starting with `/`, e.g. `/Notes/Idea`.
markdownNoInitial Markdown content.
notebookYesNotebook ID or exact notebook name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations the description carries the full burden, and it delivers two meaningful behaviors: missing parent documents are auto-created, and an existing path is not overwritten so duplicates are created instead. It stops short of stating permission/auth requirements or what the call returns, but the side-effect disclosure is genuinely useful.

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 tight sentences with zero filler; the core action is front-loaded and the path convention and collision behavior follow in order of importance.

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 three-parameter write tool with no annotations and no output schema, the description covers action, path format, parent-creation side effect, and collision behavior — enough to call it correctly. Only permission/return-value context is absent, 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 description coverage is 100%, so the schema already documents all three parameters including the `/Notes/Idea` example. The description largely repeats the path semantics rather than adding new syntax or constraints, and says nothing about `notebook` or `markdown`, 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+resource ('Create a document from Markdown') and immediately qualifies the key input (Markdown source). It is clearly distinguishable from siblings like rename_document, move_document, or insert_block without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by 'Create a document' — this is the tool for making a new document. It notes the collision case (existing path is not overwritten, a new document is created alongside), which shapes when the agent should/shouldn't rely on it, but it never names alternatives such as get_document for checking existence or list_documents for browsing.

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