Skip to main content
Glama
Sign In
SiYuan MCP Server

SiYuan MCP Server

by xgq18237
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

add_database_column

Add a new column to a SiYuan database by specifying field name, type (text, number, date, etc.), and optional icon. Enables dynamic schema extension for structured data.

Instructions

添加数据库字段

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": {
      "avID": "<avID>",
      "name": "<name>",
      "type": "<type>"
    },
    "name": "add_database_column"
  }
}

Input Schema

NameRequiredDescriptionDefault
avIDYes思源块、文档、笔记本或数据库 ID
iconNo字段图标
nameYes字段名称
typeYes字段类型
previousKeyIDNo思源块、文档、笔记本或数据库 ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

C2.8/5.0
Behavior2/5

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

Annotations indicate non-readonly (write operation) and non-destructive, but description adds no behavioral details (e.g., whether it modifies the database schema, requires permissions, or has side effects). Without annotations, this would be worse, but annotation already conveys basic behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely short (one phrase). While it is concise, it sacrifices informativeness. It could include a brief summary without being verbose.

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 5 parameters and no output schema, the description fails to explain return values, side effects, or the broader context of database column addition. Incomplete for effective agent use.

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 covers 100% of parameters with descriptions, so the description adds no additional meaning. Baseline score of 3 is appropriate given high schema coverage.

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?

Description is a clear verb+resource phrase '添加数据库字段' (add database column), accurately indicating the tool's action. However, it does not differentiate from sibling tools like remove_database_column, but the purpose is unambiguous.

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, no prerequisites or when-not-to-use advice provided. The description is too minimal to help an agent decide context.

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