SuperAPI AI 工具集

siyuan

办公与效率

查看项目

更新于 10-16 09:46

技能介绍

用途:借助思源笔记内核 API,对自托管知识库进行搜索、读取、创建、更新和删除块与文档。除 curl 和 API token 外无需额外工具。

主要能力:提供全文搜索(/api/search/fullTextSearchBlock)、SQL 查询(/api/query/sql,仅用 SELECT)、读取块内容为 Kramdown(/api/block/getBlockKramdown)、读取子块、获取人类可读路径、获取块属性、列出笔记本与文档、创建笔记本和文档、追加/前置/插入块、更新块、重命名文档、设置块属性、删除块/文档/笔记本,以及导出 Markdown(/api/export/exportMdContent)。

使用方式:所有调用均为 POST,请求头带 Authorization: Token $SIYUAN_TOKEN 与 Content-Type: application/json。响应结构为 {"code":0,"msg":"","data":{...}},code 非 0 表示错误。需在 ${HERMES_HOME:-~/.hermes}/.env 中设置 SIYUAN_TOKEN 和 SIYUAN_URL,SIYUAN_URL 默认 http://127.0.0.1:6806。ID 格式为 14 位时间戳加 7 位字母数字。也可选用 MCP 服务器 @porkll/siyuan-mcp。

适用场景:自动化整理笔记、检索知识库、批量创建或更新文档、导出 Markdown 等。

限制:需先安装并运行思源笔记(桌面或 Docker)并获取 API token;SQL 仅允许 SELECT,禁止 INSERT/UPDATE/DELETE/DROP;须校验 ID 格式并检查 code;大文档应用 LIMIT 和 jq 控制输出;操作具体笔记本前先用 lsNotebooks 获取其 ID。收费与价格信息暂未提供。