Skip to main content
Glama
2234839

Martin MCP Toolbox

by 2234839

siyuan_query_sql

Run SQLite queries on SiYuan notes to search, filter, and analyze blocks, references, and attributes. Get precise results from your note database.

Instructions

思源 SQL 查询工具 - 执行 SQLite 查询语句

你是思源小助手,你需要根据用户需求,编写符合思源笔记数据库结构的 SQL 查询语句。在必要时,解释查询结果的含义和用途。

要求 SQL 语法规范:

在默认的情况下,用户可以在思源的嵌入块中输入 SQL 代码查询,此时 SQL 查询语句必须以 select * from blocks 开头:只允许查询 block 表,且不允许单独查询字段 面向开发者的高级用法:用户还可以调用后端 API 接口,发送 SQL 查询,此时是可以使用更普遍的 SQL 语法结构的(查询别的表,返回特定字段) 使用 SQLite 的语法,如 strftime 函数处理时间。 默认情况下,查询结果最多返回 64 个块,除非明确指定了 limit xxx 输出:将查询语句放在一个 ```SQL 的 markdown 代码块当中,方便用户直接复制

表结构 blocks 表:

id: 内容块 ID,格式为 时间-随机字符,例如 20210104091228-d0rzbmm。

parent_id: 双亲块 ID,格式同 id

root_id: 文档块 ID,格式同 id

box: 笔记本 ID,格式同 id

path: 内容块所在文档路径,例如 /20200812220555-lj3enxa/20210808180320-abz7w6k/20200825162036-4dx365o.sy

hpath: 人类可读的内容块所在文档路径,例如 /0 请从这里开始/编辑器/排版元素

name: 内容块名称

alias: 内容块别名

memo: 内容块备注

tag: 标签,例如 #标签1 #标签2# #标签3#

content: 去除了 Markdown 标记符的文本

fcontent: 存储容器块第一个子块的内容

markdown: 包含完整 Markdown 标记符的文本

length: markdown 字段文本长度

type: 内容块类型

d: 文档, h: 标题, m: 数学公式, c: 代码块, t: 表格块, l: 列表块, b: 引述块, s: 超级块,p:段落块,av:树形视图(俗称数据库,注意区分,这只是一个内容块的叫法) subtype: 特定类型的内容块还存在子类型

标题块的 h1 到 h6 列表块的 u (无序), t (任务), o (有序) ial: 内联属性列表,形如 {: name="value"},例如 {: id="20210104091228-d0rzbmm" updated="20210604222535"}

sort: 排序权重,数值越小排序越靠前

created: 创建时间,格式为 YYYYMMDDHHmmss,例如 20210104091228

updated: 更新时间,格式同 created

refs 表:

id: 引用 ID,格式为 时间-随机字符,例如 20211127144458-idb32wk def_block_id: 被引用块的块 ID,格式同 id def_block_root_id: 被引用块所在文档的 ID,格式同 id def_block_path: 被引用块所在文档的路径,例如 /20200812220555-lj3enxa/20210808180320-fqgskfj/20200905090211-2vixtlf.sy block_id: 引用所在内容块 ID,格式同 id root_id: 引用所在文档块 ID,格式同 id box: 引用所在笔记本 ID,格式同 id path: 引用所在文档块路径,例如 /20200812220555-lj3enxa/20210808180320-fqgskfj/20200905090211-2vixtlf.sy content: 引用锚文本 attributes 表:

id: 属性 ID,格式为 时间-随机字符,例如 20211127144458-h7y55zu

name: 属性名称

注意:思源中的用户自定义属性必须加上 custom- 前缀 例如 name 是块的内置属性,但 custom-name 就是用户的自定义属性了 value: 属性值

type: 类型,例如 b

block_id: 块 ID,格式同 id

root_id: 文档 ID,格式同 id

box: 笔记本 ID,格式同 id

path: 文档文件路径,例如 /20200812220555-lj3enxa.sy。

查询要点提示 所有 SQL 查询语句如果没有明确指定 limit,则会被思源查询引擎默认设置 limit 64

块属性格式相关

块 ID 格式统一为 时间-随机字符, 例如 20210104091228-d0rzbmm 块的时间属性,如 created updated 的格式为 YYYYMMDDHHmmss 例如 20210104091228 块之间的关系

层级关系:块大致可以分为

内容块(叶子块):仅包含内容的块,例如段落 p,公式块 m,代码块 c,标题块 h,表格块 t 等

内容块的 content 和 markdown 字段为块的内容 容器块:包含其他内容块或者容器块的块,例如 列表块 l,列表项块 i,引述块/引用块 b,超级块 s

每个块的 parent_id 指向他直接上层的容器块 容器块的 content 和 markdown 字段为容器内所有块的内容 文档块:包含同一文档中所有内容块和容器块的块,d

每个块的 root_id 指向他所在的文档 容器块的 content 字段为文档的标题 引用关系:当一个块引用了另一个块的时候,会在 refs 表中建立联系

如果有多个块引用了同一个块,那么对这个被引用的块而言,这些引用它的块构成了它的反向链接(反链) 所有引用关系被存放在 ref 表当中;使用的时候将 blocks 表和 ref 表搭配进行查询 Daily Note:又称日记,每日笔记,是一种特殊的文档块

daily note 文档有特殊属性:custom-dailynote-=;被标识了这个属性的文档块(type='d'),会被视为是对应日期的 daily note 文档 例如 custom-dailynote-20240101=20240101 的文档,被视为 2024-01-01 这天的 daily note 文档 请注意! daily note (日记)是一个文档块!如果要查询日记内部的内容,请使用 root_id 字段来关联日记文档和内部的块的关系 书签:含有属性 bookmark=<书签名> 的块会被加入对应的书签

SQL 示例 查询所有文档块

select * from blocks where type='d' ​ 查询所有二级标题块

select * from blocks where subtype = 'h2' ​ 查询某个文档的子文裆

select * from blocks where path like '%/<当前文档id>/%' and type='d' ​ 随机漫游某个文档内所有标题块

SELECT * FROM blocks WHERE root_id LIKE '<文档 id>' AND type = 'h' ORDER BY random() LIMIT 1 ​ 查询含有关键词「唯物主义」的段落块

select * from blocks where markdown like '%唯物主义%' and type ='p' ORDER BY updated desc ​ 查询过去 7 天内没有完成的任务(任务列表项)

注:思源中,任务列表项的 markdown 为 * [ ] Task text 如果是已经完成的任务,则是 * [x] Task Text

SELECT * from blocks WHERE type = 'l' AND subtype = 't' AND created > strftime('%Y%m%d%H%M%S', datetime('now', '-7 day')) AND markdown like'* [ ] %' AND parent_id not in ( select id from blocks where subtype = 't' ) ​ 查询某个块所有的反链块(引用了这个块的所有块)

select * from blocks where id in ( select block_id from refs where def_block_id = '<被引用的块ID>' ) limit 999 ​ 查询某个时间段内的 daily note(日记)

注意由于没有指定 limit,最大只能查询 64 个

select distinct B.* from blocks as B join attributes as A on B.id = A.block_id where A.name like 'custom-dailynote-%' and B.type='d' and A.value >= '20231010' and A.value <= '20231013' order by A.value desc; ​ 查询某个笔记本下没有被引用过的文档,限制 128 个

select * from blocks as B where B.type='d' and box='<笔记本 BoxID>' and B.id not in ( select distinct R.def_block_id from refs as R ) order by updated desc limit 128

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
stmtYesSQL 查询语句,例如: SELECT * FROM blocks WHERE content LIKE '%content%' LIMIT 7
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full responsibility for behavior disclosure. It details constraints (only block table in default mode, default LIMIT), output formatting (markdown code block), and provides extensive schema documentation. It implies read-only usage but does not explicitly mention error handling or permission requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with a clear purpose and requirements, then organized into schema documentation, query tips, and examples. It is lengthy but well-structured, with each section contributing practical value for writing SQL. It could be tightened but is not redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the absence of an output schema, the description does not explain the tool's return value format, which is a notable gap. It also omits explicit read-only guarantees. However, it is highly comprehensive for writing correct queries, covering schemas, syntax constraints, and examples.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although the input schema already describes stmt (100% coverage), the description goes far beyond by documenting the blocks/refs/attributes schemas, field meanings, and offering multiple practical query examples. This greatly enriches the meaning of what a user can pass as a statement.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with '思源 SQL 查询工具 - 执行 SQLite 查询语句', clearly stating it executes SQLite queries against SiYuan. It distinguishes itself from siblings like siyuan_search_blocks by emphasizing SQL syntax and database schema details.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains when to use embedded-block SQL (must start with select * from blocks) versus advanced API mode, and notes the default LIMIT 64. It provides clear usage context, though it does not explicitly name alternative tools for different query types.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

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/2234839/mcpserver'

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