SiYuan Note MCP Server
by MCP-Mirror
An MCP server implementation that provides integration with the SiYuan Note system. It enables AI models to access and manipulate note data.
Last updated: N/A
What is SiYuan Note MCP Server?
This is an MCP (Model Context Protocol) server designed to integrate with the SiYuan Note system. It acts as a bridge, allowing AI models to interact with and manage data stored within SiYuan notebooks.
How to use SiYuan Note MCP Server?
To use this server, you need to configure the SIYUAN_TOKEN
environment variable with your SiYuan Note API token. You can then run the server locally using pnpm start
, or deploy it using Docker. The server exposes various commands for managing notebooks, documents, content blocks, and other features, which can be accessed via the MCP protocol.
Key features of SiYuan Note MCP Server
Notebook Management
Document Operations
Block Control
File and Asset Management
SQL Query Support
Attribute Management
Export and Conversion
System Functions
Use cases of SiYuan Note MCP Server
Enabling AI models to summarize notes in SiYuan.
Automating note organization and tagging.
Integrating SiYuan notes with other AI-powered tools.
Using AI to generate new content within SiYuan notebooks.
FAQ from SiYuan Note MCP Server
How do I get my SiYuan Note API token?
How do I get my SiYuan Note API token?
You can find your SiYuan Note API token in the SiYuan Note settings, under the 'About' section.
What is MCP?
What is MCP?
MCP stands for Model Context Protocol. It is a protocol that allows AI models to access and interact with data from various sources.
How do I run this server in Docker?
How do I run this server in Docker?
You can run the server in Docker using the provided docker run
command, ensuring you set the SIYUAN_TOKEN
environment variable.
What commands are available?
What commands are available?
A list of available commands can be found in the README under the 'Command List' section, covering areas like asset management, block operations, file operations, and more.
What license is this project released under?
What license is this project released under?
This project is released under the ISC License, allowing for free use, modification, and distribution, subject to the terms and conditions of the ISC License.