思源笔记 REST API 工具

通过 REST API 与思源笔记交互，支持笔记本、文档、块的增删改查、属性、SQL 查询、文件操作、导出，以及从 Memory MCP 同步实体。

快速开始

export SIYUAN_URL="http://127.0.0.1:6806"
export SIYUAN_API_TOKEN="your-token"

node skill.js notebook ls                                            # 列笔记本
node skill.js sql "SELECT * FROM blocks WHERE type='d' LIMIT 10"    # SQL 查询
node skill.js doc create --notebook <id> --path note "标题" "# 正文" # 建文档
node skill.js export md <doc-id>                                     # 导出为 Markdown

命令总表

📖 详细用法、参数说明与完整案例：

• 📝 创建（建笔记本 / 文档 / 写块）→ examples/create.md
• 🔍 查询（检索 / SQL / 导出）→ examples/query.md
• ✏️ 修改（改 / 删 / 移动 / 属性 / 同步）→ examples/modify.md

选项

认证与配置

访问需 API Token：思源笔记 > 设置 > 关于 > API Token，通过 Authorization: Token <token> 传递。

也可在同目录 .env 写入这两个变量。URL / Token 还可作为命令尾部位置参数临时覆盖。

命令别名

常见问题

• Token 怎么拿？ 设置 > 关于 > API Token。
• 连接被拒？ 确认思源已启动，默认监听 http://127.0.0.1:6806。
• 怎么查文档内容？ export md <id> 导出 Markdown，或 block kramdown <id> 取源码，或 sql 直接查 blocks 表。
• 怎么写 / 改笔记？ 见 examples/create.md 与 examples/modify.md。