SiYuan Note MCP Server

| Features

• | Notebook Management

• | Document Operations

• | Block Control

• | File and Asset Management

• SQL | SQL Query Support

• | Attribute Management

• | Export and Conversion

• | System Functions

| Command List

| Asset Management

• `assets.uploadAssets` - | Upload assets

| Attribute Management

• `attr.setBlockAttrs` - | Set block attributes

• `attr.getBlockAttrs` - | Get block attributes

| Block Operations

• `block.insertBlock` - | Insert a block

• `block.updateBlock` - | Update block content

• `block.deleteBlock` - | Delete a block

• `block.moveBlock` - | Move a block

• `block.getBlockKramdown` - Markdown | Get block Kramdown content

| Format Conversion

• `convert.pandoc` - Pandoc | Convert content using Pandoc

| Export Functions

• `export.exportNotebook` - | Export notebook

• `export.exportDoc` - | Export document

| File Operations

• `file.getFile` - | Get file content

• `file.putFile` - | Put file content

• `file.removeFile` - | Remove file

• `file.readDir` - | List files in directory

| File Tree Operations

• `filetree.createDocWithMd` - Markdown | Create document with Markdown

• `filetree.renameDoc` - | Rename document

• `filetree.removeDoc` - | Remove document

• `filetree.moveDocs` - | Move documents

• `filetree.getHPathByPath` - | Get document HPath by path

• `filetree.getHPathByID` - ID | Get document HPath by ID

| Network Proxy

• `network.forwardProxy` - | Forward proxy request

| Notebook Management

• `notebook.lsNotebooks` - | List all notebooks

• `notebook.openNotebook` - | Open notebook

• `notebook.closeNotebook` - | Close notebook

• `notebook.renameNotebook` - | Rename notebook

• `notebook.createNotebook` - | Create notebook

• `notebook.removeNotebook` - | Remove notebook

• `notebook.getNotebookConf` - | Get notebook configuration

• `notebook.setNotebookConf` - | Set notebook configuration

| Notifications

• `notification.pushMsg` - | Push message notification

• `notification.pushErrMsg` - | Push error message notification

| Query Functions

• `query.sql` - SQL | Execute SQL query

• `query.block` - ID | Query block by ID

| Search Functions

• `search.fullTextSearch` - | Full text search

SQL | SQL Query

• `sql.sql` - SQL | Execute SQL query

| System Functions

• `system.getBootProgress` - | Get boot progress

• `system.getVersion` - | Get system version

• `system.getCurrentTime` - | Get current time

| Template Functions

• `template.renderTemplate` - | Render template

• `template.renderSprig` - Sprig | Render Sprig template

| Usage

| Environment Variables

• `SIYUAN_TOKEN` - API | SiYuan Note API token (required) * - | Check in SiYuan Note Settings - About * API | Used for API authentication

Claude Desktop | Using in Claude Desktop

| Local Run

1. | Install dependencies:

1. | Set environment variables:

1. | Start service:

Docker | Docker Run

| Build

| Requirements

• Node.js >= 23.10.0

• pnpm

| Local Build

Docker | Docker Build

| License

| Related Resources

• [ | SiYuan Note](https://github.com/siyuan-note/siyuan)

• [Model Context Protocol](https://modelcontextprotocol.io/)

• [ API | SiYuan Note API Documentation](https://github.com/siyuan-note/siyuan/blob/master/API.md)