Skip to main content
Glama
xgq18237

SiYuan MCP Server

by xgq18237

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
SIYUAN_URLNoFull SiYuan URL, overrides HOST and PORT if set.
SIYUAN_HOSTNoSiYuan host, default 127.0.0.1, ignored if SIYUAN_URL is set.127.0.0.1
SIYUAN_PORTNoSiYuan port, default 6806, ignored if SIYUAN_URL is set.6806
SIYUAN_TOKENYesSiYuan API Token, required for authentication.
SIYUAN_MCP_DEBUGNoSet to '1' to output debug info to stderr.0
SIYUAN_MCP_TIMEOUT_MSNoTimeout per API request in milliseconds.120000
SIYUAN_MCP_UPLOAD_ROOTSNoColon/semicolon-separated list of allowed upload directories for local files.current working directory
SIYUAN_MCP_MAX_TEXT_CHARSNoMaximum text preview length for MCP.30000
SIYUAN_MCP_MAX_RESPONSE_BYTESNoMaximum response byte size.10485760
SIYUAN_MCP_PROTECT_DESTRUCTIVENoExplicitly set to 'true' or '1' to block destructive operations.false
SIYUAN_MCP_WRITE_PATH_PREFIXESNoComma-separated allowed write path prefixes in workspace./data/assets,/temp

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{}
resources
{}

Tools

Functions exposed to the LLM to take actions

NameDescription
list_notebooksA

列出所有思源笔记本及其打开状态

open_notebookB

打开指定笔记本

close_notebookB

关闭指定笔记本

rename_notebookC

重命名笔记本

create_notebookB

创建新笔记本

remove_notebookA

删除笔记本及其内容;可通过保护开关禁用

get_notebook_confB

获取笔记本配置

set_notebook_confC

保存笔记本配置

create_docB

在指定笔记本中新建 Markdown 文档

rename_docA

按存储路径重命名文档

rename_doc_by_idC

按 ID 重命名文档

remove_docA

按路径删除文档

remove_doc_by_idB

按 ID 删除文档

move_docsC

移动一组文档

move_docs_by_idC

按 ID 移动一组文档

search_docsB

按标题搜索文档

list_docsB

列出指定笔记本路径下的文档

get_hpath_by_pathA

根据存储路径获取人类可读路径

get_hpath_by_idA

根据 ID 获取人类可读路径

get_path_by_idB

根据 ID 获取存储路径

get_ids_by_hpathC

根据人类可读路径获取 ID

insert_blockB

在指定锚点插入块;nextID、previousID、parentID 至少提供一个

prepend_blockB

在父块开头插入子块

append_blockA

在父块末尾插入子块

update_blockC

更新块内容

delete_blockC

删除块

move_blockC

移动块;previousID 或 parentID 至少提供一个

batch_insert_blocksC

批量插入块

batch_update_blocksC

批量更新块

get_block_infoB

获取块的元数据

get_block_breadcrumbA

获取块的面包屑路径

get_block_kramdownB

获取块 Kramdown 源码

get_child_blocksB

获取直接子块

fold_blockD

折叠块

unfold_blockD

展开块

transfer_block_refC

转移块引用

set_block_attrsC

设置块属性

get_block_attrsC

获取块属性

search_blocksB

使用思源全文搜索查找内容块

sql_queryB

执行 SQL 语句;调用方应自行确认写入类语句的影响

flush_transactionB

等待思源事务队列落盘

create_databaseB

创建并初始化原生思源数据库,可同时创建字段

get_databaseC

分页渲染数据库

get_database_keysB

获取数据库字段定义

rename_databaseD

重命名数据库

add_database_columnC

添加数据库字段

remove_database_columnB

删除数据库字段

append_database_rowsC

以标题批量添加非绑定数据库条目

set_database_cellB

设置单个数据库单元格;value 使用思源 AV Value JSON 结构

batch_set_database_cellsB

批量设置数据库单元格;values 使用思源批量 AV Value 结构

remove_database_rowsC

删除数据库条目

get_fileA

读取工作空间文件;文本/JSON直接返回,二进制以 Base64 返回

put_fileC

通过 Multipart 写入工作空间文件

remove_fileC

删除工作空间文件

rename_fileC

重命名工作空间文件

read_dirC

列出工作空间目录

upload_assetB

上传一个或多个本地资源文件

export_md_contentC

导出文档 Markdown

export_resourcesB

导出文件与目录

push_msgB

向思源界面推送普通消息

push_err_msgB

向思源界面推送错误消息

get_versionA

获取思源版本

get_current_timeA

获取思源内核当前时间

get_boot_progressA

获取思源启动进度

check_siyuan_statusA

检查连接、鉴权、笔记本和 SQL 可用性

get_workspace_infoA

获取脱敏后的 MCP 连接与安全配置

render_templateC

渲染模板文件

render_sprigC

渲染 Sprig 模板

pandoc_convertC

执行思源 Pandoc 转换

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription
最近更新的 10 篇文档仅返回必要字段,避免将整篇正文注入上下文
所有笔记本

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/xgq18237/siyuan_mcp_server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server