Skip to main content
Glama
Sign In
SiYuan MCP Server

SiYuan MCP Server

by xgq18237
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_ids_by_hpath

Read-onlyIdempotent

Get block or document IDs from human-readable paths within a SiYuan notebook by specifying the notebook ID and path.

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": {
      "notebook": "<notebook>",
      "path": "<path>"
    },
    "name": "get_ids_by_hpath"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes人类可读路径
notebookYes思源块、文档、笔记本或数据库 ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds no extra behavioral context beyond what is in the annotations, such as error handling, performance implications, or side effects.

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, concise phrase with no superfluous text. It is efficient but arguably too minimal, leaving out important details.

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?

With no output schema, the description should hint at the format or nature of the returned IDs. It does not. For a simple 2-param tool, the description is incomplete without specifying what 'get ID' means in terms of output structure or multiplicity.

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%, so the schema already documents both parameters. The description adds no additional meaning beyond the schema's descriptions, which are already present. Baseline 3 is appropriate.

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 action ('Get') and the resource ('ID based on human-readable path'). It is specific about the input and output mapping. However, it does not differentiate from similar sibling tools like 'get_path_by_id' or 'get_hpath_by_path'.

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. The description lacks any context about prerequisites, typical use cases, or when to avoid it.

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