SiYuan FAQs

Question 1

What is SiYuan MCP Server?

Accepted Answer

SiYuan MCP Server is an open-source tool that exposes the complete SiYuan Note API functionality via the Model Context Protocol (MCP), enabling seamless integration with AI tools, large language models, and other third-party applications.

Question 2

What kind of SiYuan Note data can I access or manage?

Accepted Answer

You gain comprehensive control over your SiYuan Note data, including managing notebooks, documents, and individual blocks. It also supports advanced features like SQL querying for data extraction, robust file and resource management, and various export functionalities.

Question 3

How do I get started with SiYuan MCP Server?

Accepted Answer

You can quickly deploy it using `npx` or Docker. Configuration involves setting your SiYuan server details (host, port, API token) within your MCP client settings, such as those found in Cursor or Claude Desktop, to establish the connection.

Question 4

Is SiYuan MCP Server secure and performant?

Accepted Answer

Yes, it ensures data security through mandatory API token authentication. For performance, it utilizes asynchronous processing, supports batch operations, and includes transaction management for efficient and reliable data handling.

Question 5

How does SiYuan MCP Server integrate with AI tools?

Accepted Answer

It uses the Model Context Protocol (MCP) to provide a standardized interface. This allows AI clients like Cursor and Claude Desktop to directly access and interact with your SiYuan Note content, leveraging your knowledge base for AI-powered tasks.

SiYuan

SiYuan

Key Features

Use Cases

Key Features

Use Cases