Skip to main content
Glama
xgq18237

SiYuan MCP Server

by xgq18237

set_notebook_conf

Save notebook configuration in SiYuan Note by providing the notebook ID and a full configuration object to update settings.

Instructions

保存笔记本配置

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
confYes完整配置对象
notebookYes思源块、文档、笔记本或数据库 ID
Behavior2/5

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

Annotations declare readOnlyHint=false and destructiveHint=false, but the description only says 'save', implying mutation. It does not disclose whether the configuration is merged or overwritten, what permissions are needed, or what happens on failure. No additional behavioral context beyond the annotations is provided.

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 sentence, concise and front-loaded. It gets straight to the point, but could benefit from slight expansion without losing conciseness.

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?

The tool has a nested object parameter and no output schema. The description does not explain the behavior (e.g., replace vs merge), return value, or error conditions. This is insufficient for a tool that modifies configuration.

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 descriptions for both parameters: 'conf' is '完整配置对象' and 'notebook' is '思源块、文档、笔记本或数据库 ID'. The description adds no further meaning beyond the schema, 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.

Purpose4/5

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

The description '保存笔记本配置' translates to 'Save notebook configuration', which clearly indicates the action (save) and the resource (notebook configuration). It distinguishes from the sibling tool 'get_notebook_conf' which retrieves configuration.

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. There is no mention of prerequisites, when to avoid using it, or comparison with related tools like 'get_notebook_conf'.

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