SiYuan Note MCP Server
@MCP-Mirror
Mirror of
Overview
What is SiYuan Note MCP Server?
SiYuan Note MCP Server is an MCP server implementation that integrates with the SiYuan Note system, enabling AI models to access and manipulate note data. It provides a command‑based interface for notebooks, documents, blocks, files, assets, SQL queries, attributes, exports, and system functions.
How to use SiYuan Note MCP Server?
Configure a SIYUAN_TOKEN environment variable with the SiYuan API token (found in SiYuan Note Settings > About). Add the server to Claude Desktop’s claude_desktop_config.json using npx -y @onigeya/siyuan-mcp-server, or run locally with pnpm start after installing dependencies. A Docker image is also available.
Key features of SiYuan Note MCP Server
- Notebook and document management (create, rename, delete, move)
- Content block operations (insert, update, delete, move)
- File and asset upload/manipulation
- SQL and full‑text search queries
- Attribute management (set and get block attributes)
- Export and format conversion (Pandoc support)
Use cases of SiYuan Note MCP Server
- AI agents reading, writing, or reorganizing notes in SiYuan
- Automating notebook structure and document creation from markdown
- Searching and querying note content programmatically
- Integrating SiYuan with external workflows via file and asset operations
FAQ from SiYuan Note MCP Server
What dependencies or runtime are required?
Node.js >= 23.10.0 and pnpm are required for local builds. A Docker image is also provided.
How is authentication handled?
The server requires a SIYUAN_TOKEN environment variable, which is the API token from SiYuan Note. It is used for API authentication.
What transports or protocols does it use?
The README does not specify transport details; it is an MCP server (presumably stdio for Claude Desktop) but no explicit transport is mentioned.
Can it execute arbitrary SQL on the SiYuan database?
Yes, it provides query.sql and sql.sql commands to execute SQL queries against the SiYuan note database.
Where does the data live?
Data is stored within the SiYuan Note system; the server accesses it via SiYuan’s API. No data is stored by the server itself.
