SiYuan MCP Server

Upload one or more files to SiYuan assets. Provide either content (base64/JSON) or a URL to fetch from. Can optionally auto-insert all uploaded assets into a document in order.

Set, update, or delete attributes for a specific block. To delete an attribute, set its value to an empty string.

Get all attributes of a specific block.

Set attributes on multiple blocks at once. More efficient than calling set_block_attributes multiple times.

Insert a new block at a specified position. Content must be in markdown format. Position is anchored by one of: `nextID` (ID of block after), `previousID` (ID of block before), or `parentID` (parent block ID). `nextID` has highest priority.

Insert a new block as the first child of a parent container block. Content must be in markdown format.

Insert a new block as the last child of a parent container block. Content must be in markdown format.

Update an existing block's content by ID. Content must be in markdown format. Note: for container blocks (list, blockquote, super block), child block IDs will be regenerated. To preserve custom block attributes, append an IAL line at the end (e.g. `{: custom-foo="bar"}`); use `siyuan_get_block_kramd…

Fold (collapse) a block to hide its children. Works on headings and other container blocks.

Unfold (expand) a block to show its children.

Delete one or more blocks by their IDs. This action is irreversible.

List all notebooks in SiYuan and return their metadata(such as id, open status, dailyNoteSavePath etc.).

Read the content of a daily note for a specific date.

Retrieve the content of a document or block by its ID or path

Get block content in Kramdown format from SiYuan. Unlike plain text, Kramdown preserves all rich formatting including colors, attributes, and IDs. Use this tool before modifying blocks to ensure formatting is preserved.

Get the human-readable path (hpath) for a document or block. Optionally includes document outline for context.

Get the outline (table of contents) of a document. Returns headings hierarchy which helps understand document structure.

Export a document as HTML. Useful for getting a rendered preview of the document content.

Append Markdown content to the end of a document in SiYuan.

Create a new note under a parent document in SiYuan with a specified title and Markdown content.

Create a new note under a parent document in SiYuan with a specified title and Markdown content.

Rename a document.

Delete a document. This action moves the document to trash and is irreversible.

Rename an existing notebook in SiYuan.

Read a file from SiYuan workspace. For text files, returns content in structured data. For media files (images/audio), returns metadata in structured data and the binary content as separate MCP content blocks. For other binary files, returns metadata with download URL only.

Write content to a file in SiYuan workspace. Content can be text, base64-encoded binary, JSON object/array, or a URL to fetch from.

Delete a file or directory from SiYuan workspace.

Rename or move a file within SiYuan workspace.

List contents of a directory in SiYuan workspace. Returns file/directory names with metadata.

Create a new directory in SiYuan workspace.

Create a zip archive from files or directories in SiYuan workspace. Returns a download URL for the zip file. Can archive any workspace path including assets, widgets, notebooks, etc.

Create New Document, and Make Flashcards with Specific Method

Create flashcards from one or more block IDs.

Delete flashcards from a deck using their corresponding block IDs.

Provides help with the Markdown syntax used in SiYuan, including SQL embed blocks, block references, and super block layout syntax.

Provides help with the template functions available in SiYuan, including .action{} syntax, Sprig functions, and built-in variables.

Move one or more documents to a target location. Documents can be moved under a parent document or to the root of a notebook.

Move one or more blocks (paragraph, heading, superblock, table, etc.) to a target location. Blocks are moved in order, maintaining their relative sequence. Does not support moving document blocks — use siyuan_move_docs_by_ids for documents.

Retrieve all documents or blocks that reference a specified document or block within the workspace. The result includes the referencing document's ID, name, notebook ID, and path. Useful for understanding backlinks and document relationships within the knowledge base.

Retrieve the basic information of sub-documents under a specified document within the SiYuan workspace. Useful for analyzing document structure and hierarchy relationships.

Get all child blocks under a parent block by its ID. This includes directly nested blocks and blocks under headings. Long block content will be abbreviated. Useful for understanding block hierarchy and content organization.

Find blocks by text content using full-text search. Searches paragraphs, headings, and other content blocks. Optionally filter by document or notebook using the scope parameter. For complex queries with date ranges, path restrictions, or metadata filtering, use `siyuan_query_sql` instead.

Deprecated alias for siyuan_find_block. Perform a keyword-based full-text search across blocks in SiYuan. Use `siyuan_find_block` for the full feature set including scope filtering and hpath support.

Provides documentation about SiYuan's advanced query syntax for searching content blocks, including boolean operators (AND, OR, NOT).

Provides the SiYuan database schema, including table names, field names, and their relationships, to help construct valid SQL queries for retrieving notes or note content. Returns the schema in markdown format.

Provides a SQL cheatsheet with query examples for SiYuan database, including FTS5 full-text search, window functions, JSON operations, and common patterns.

Execute SQL queries on SiYuan's SQLite database (read-only). This tool is also used when you need to search notes content. Always use the 'siyuan_database_schema' tool to understand the database schema, including table names, field names, and relationships, before writing your query. Supports advanc…

Fast full-text search using FTS5 with BM25 relevance ranking. Returns matching blocks with highlighted snippets. Supports FTS5 query syntax: AND (implicit), OR, NOT, "exact phrase", prefix*, column:term.

Create a new template file or overwrite an existing one in the SiYuan workspace. Templates are stored as .md files under /data/templates/.

Search for existing templates within the SiYuan workspace using a keyword. Returns a list of matching template names.

Render a template and insert the result into a specified document. The template is rendered with the document as context, then the rendered content is prepended to the document.

Retrieve the raw source content of a template file. Useful for inspecting or editing the template structure.

Delete a template file from the workspace. This action is permanent.

Generate the rendered DOM of a template without modifying the document. Use this to check the output or get the content for further processing before any insertion.

Render a Sprig template string. Useful for testing template expressions without creating a template file.

Push a notification message to the SiYuan UI. Useful for notifying the user about task progress or completion.

Reindex a document tree. Useful after batch operations to ensure the index is up to date.

Flush pending database transactions. Call this after write operations (insert/update/delete blocks) if you need to immediately query the updated data. SiYuan uses async write queues for performance, so this ensures all pending writes are committed.

This tool provides a Retrieval-Augmented Generation (RAG) based Q&A capability. It generates context-aware answers using only the notes that the user has explicitly indexed from their siyuan-notes. Please note: the tool does not access or use all documents—only those that have been indexed by the us…