Skip to main content
Glama
xgq18237

SiYuan MCP Server

by xgq18237

search_blocks

Read-onlyIdempotent

Search content blocks in SiYuan notes using full-text queries, supporting search syntax, regular expressions, and filters by notebook, document path, or block type.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo页码
pathsNo限定笔记本/文档路径
queryYes搜索词、查询语法或正则
typesNo块类型开关,例如 {"d":true,"p":true}
methodNo0 关键词、1 查询语法、3 正则;不开放 SQL 模式
groupByNo0 不分组、1 按文档分组
orderByNo排序模式
pageSizeNo每页数量
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description does not need to restate safety. It adds 'full-text search' context but no additional behavioral traits such as performance implications or index requirements. No contradiction.

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 a single short sentence that conveys the core function. It is front-loaded and avoids verbosity, but being only in Chinese may reduce accessibility for multilingual agents.

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

Completeness2/5

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

Despite 8 parameters and nested objects, the description does not explain return values, query syntax, or typical usage patterns. The output schema is absent, and the description fails to compensate, leaving gaps for an agent to correctly invoke the tool.

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

Parameters3/5

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

Schema description coverage is 100% (all parameters have descriptions). The tool description adds no new parameter information beyond what the schema already provides, so a baseline of 3 is appropriate.

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 specifies the verb 'search' (via full-text search) and the resource 'content blocks', clearly distinguishing it from sibling tools like search_docs which search at document level. The purpose is unambiguous.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. It does not mention conditions, limitations, or relationships with other search-related sibling tools (e.g., search_docs, sql_query).

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/xgq18237/siyuan_mcp_server'

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