Skip to main content
Glama
Sign In
SiYuan MCP Server

SiYuan MCP Server

by xgq18237
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_path_by_id

Read-onlyIdempotent

Retrieve the storage path of a SiYuan block, document, notebook, or database by providing its ID.

Instructions

根据 ID 获取存储路径

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "get_path_by_id"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes思源块、文档、笔记本或数据库 ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description does not add behavioral context beyond 'get storage path', which is consistent but not informative. 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.

Conciseness5/5

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

The description is a single sentence that front-loads the core purpose without extraneous words. Every word contributes value.

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 being a simple tool, there is no output schema, and the description does not explain what the 'storage path' return value looks like or its format. The agent may lack sufficient context to interpret results correctly.

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%, and the schema fully describes the 'id' parameter with pattern and description. The description only echoes '由 ID' without adding new meaning, meeting the baseline for high schema coverage.

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

Purpose4/5

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

The description clearly states the verb ('获取'/'get') and resource ('存储路径'/'storage path') with the input ID. However, it does not differentiate from sibling tools like get_hpath_by_id or get_hpath_by_path, which are conceptually similar.

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?

The description provides no guidance on when to use this tool versus alternatives (e.g., get_hpath_by_id for hierarchical paths). It lacks any contextual or exclusionary hints.

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

Deploy Server

Other Tools