SiYuan Note MCP Server logo

SiYuan Note MCP Server

by onigeya

An MCP server implementation that provides integration with the SiYuan Note system, enabling AI models to access and manipulate note data. It offers a range of functionalities for notebook management, document operations, and content block control.

View on GitHub

Last updated: N/A

What is SiYuan Note MCP Server?

SiYuan Note MCP Server is an implementation of the Model Context Protocol (MCP) server designed to integrate with the SiYuan Note system. It allows AI models to interact with and manage SiYuan notes.

How to use SiYuan Note MCP Server?

To use the server, you need to configure the SIYUAN_TOKEN environment variable with your SiYuan API token. You can then run the server locally using pnpm start or deploy it using Docker. For integration with Claude Desktop, add the provided configuration to claude_desktop_config.json.

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 access and analyze SiYuan notes

  • Automating note management tasks using AI

  • Integrating SiYuan notes with other AI-powered applications

  • Building custom AI workflows for note taking and knowledge management

FAQ from SiYuan Note MCP Server

What is the SIYUAN_TOKEN?

The SIYUAN_TOKEN is your SiYuan Note API token, used for authentication.

How do I find my SIYUAN_TOKEN?

You can find your SIYUAN_TOKEN in SiYuan Note Settings - About.

How do I run the server locally?

Install dependencies with pnpm install, set the SIYUAN_TOKEN environment variable, and start the server with pnpm start.

How do I run the server with Docker?

Use the provided docker run command, ensuring you set the SIYUAN_TOKEN environment variable.

What license is the project released under?

The project is released under the ISC License, allowing free use, modification, and distribution.