get_notebook_conf
Fetches the configuration of a specified notebook in SiYuan Note. Use a notebook ID to retrieve its settings.
Instructions
获取笔记本配置
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notebook | Yes | 思源块、文档、笔记本或数据库 ID |
Fetches the configuration of a specified notebook in SiYuan Note. Use a notebook ID to retrieve its settings.
获取笔记本配置
| Name | Required | Description | Default |
|---|---|---|---|
| notebook | Yes | 思源块、文档、笔记本或数据库 ID |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. Description adds no extra behavioral context (e.g., error handling, response format). With existing annotations, a 3 is appropriate as it does not detract but also adds no value.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Extremely concise (one phrase), front-loaded. No wasted words. However, it is so minimal that it may be under-specifying, but still earns a 4 for efficiency.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema provided, and description does not hint at return values or behavior. Given the tool's simplicity, some guidance on expected output would improve completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% coverage with parameter description. The tool description does not add meaning beyond what the schema provides. Baseline 3 is warranted.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description '获取笔记本配置' (Get notebook configuration) clearly states the action (get) and resource (notebook configuration). It distinguishes well from siblings like set_notebook_conf, but could be more specific about what configuration entails.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives like set_notebook_conf or list_notebooks. No context about prerequisites or typical use cases provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
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