Skip to main content
Glama
xgq18237

SiYuan MCP Server

by xgq18237

get_block_breadcrumb

Read-onlyIdempotent

Retrieves the hierarchical breadcrumb path for a block in SiYuan, showing its location within notebooks and documents.

Instructions

获取块的面包屑路径

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes思源块、文档、笔记本或数据库 ID
excludeTypesNo排除的块类型
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, indicating a safe read operation. The description adds that it retrieves a breadcrumb path but does not elaborate on specifics such as whether it returns ancestor IDs, names, or structure. No contradictions with annotations.

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

Conciseness5/5

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

The description is a single short sentence in Chinese, containing only essential information. It is front-loaded and has no fluff, earning its place perfectly.

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?

For a read-only retrieval tool with good schema annotations, the description is somewhat adequate. However, it does not specify the format of the returned breadcrumb path (e.g., array of block IDs or titles), which an agent needs to interpret the output. Since no output schema exists, this is a gap.

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 coverage is 100% with both parameters described. The description does not add extra meaning beyond the schema. The 'id' parameter is well-defined by the regex and description, and 'excludeTypes' is clear from schema. 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 clearly states the action ('获取'/'get') and the resource ('面包屑路径'/'breadcrumb path') and the object ('块'/'block'). Among sibling tools like 'get_block_info' and 'get_child_blocks', this uniquely identifies retrieving the hierarchical breadcrumb path.

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

Usage Guidelines3/5

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

The description does not provide any guidance on when to use this tool versus alternatives like 'get_hpath_by_id' or 'get_path_by_id'. The context of breadcrumb path is implied but no explicit when/when-not or alternatives are mentioned.

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