sql_query
Execute SQL statements to query or modify SiYuan Note data. Use caution with write operations to avoid unintended changes.
Instructions
执行 SQL 语句;调用方应自行确认写入类语句的影响
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sql | Yes | SQL 语句 |
Execute SQL statements to query or modify SiYuan Note data. Use caution with write operations to avoid unintended changes.
执行 SQL 语句;调用方应自行确认写入类语句的影响
| Name | Required | Description | Default |
|---|---|---|---|
| sql | Yes | SQL 语句 |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already set destructiveHint=true, so the description adds a caution that the caller should confirm write impacts. This provides minimal extra behavioral context beyond the annotation.
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?
The description is a single sentence with no wasted words. It efficiently conveys the core action and a warning, though it lacks structure like separating conditions or examples.
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?
The description omits critical details: which database is targeted, return value, error handling, and transaction behavior. Given the destructive nature, more completeness is expected.
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?
Schema coverage is 100% with a basic description for the sql parameter. The tool description does not add any further meaning, such as syntax examples or acceptable SQL dialects.
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?
The description clearly states 'Execute SQL statement', which is a specific verb+resource. It is distinct among siblings as no other tool directly executes SQL queries.
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 is given on when to use this tool versus alternative tools like create_database or set_database_cell. The only hint is a warning about write statements, but no explicit when-to-use or when-not-to-use.
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