Skip to main content
Glama
blueblueeyes

siyuan-mcp-server

by blueblueeyes

help

Retrieve detailed help documentation for any command type within SiYuan Note systems, enabling quick understanding of command usage and parameters.

Instructions

获取命令的帮助信息

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeYes命令类型
Behavior2/5

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

The description merely restates the purpose without disclosing behavioral traits such as return format, documentation scope, or any constraints. No annotations are provided to compensate.

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, concise sentence with no wasted words.

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?

Given the simplicity (1 param, no output schema), the description is adequate but lacks any detail about the help content, format, or scope.

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 a parameter description for 'type'. The tool description adds context that the parameter refers to a command for which help is sought, meeting the baseline expectation.

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 'get help information for commands' clearly states the verb and resource. It implicitly distinguishes from siblings executeCommand (execution) and queryCommands (querying) by focusing on help retrieval.

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 on when to use this tool versus alternatives. It does not specify conditions, prerequisites, or exclusions.

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/blueblueeyes/siyuan-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server