Skip to main content
Glama
Sign In
siyuan-mcp-server

siyuan-mcp-server

by leolulu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python

update_block

Replace the content of a specific block in a SiYuan knowledge base; provide the block ID and new markdown or DOM data for a complete overwrite, avoiding unintended edits.

Instructions

更新块内容。

适用场景: - 已知块 ID 时，直接替换该块内容。

使用方法: - block_id: 目标块 ID。 - data_type: 仅支持 markdown 或 dom。 - data: 新内容。

注意事项: - 这是整块替换，不是局部 patch。 - 修改前请确保 block_id 指向正确块，避免误改。

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": {
      "block_id": "<block_id>",
      "data": "<data>"
    },
    "name": "update_block"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYes
block_idYes
data_typeNomarkdown

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.31.0

TDQS

A4.1/5.0
Behavior4/5

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

没有 annotations，描述承担了行为披露责任。它说明了关键行为：整块替换、不是局部 patch，并警告修改前确认 block_id 避免误改。虽然没有提及权限或是否可恢复，但核心破坏性特征已透明化。

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?

结构清晰：先说明目的，再分场景、用法、注意事项三个小节，每项内容都直接有用，没有冗词或重复。信息密度高且易扫读。

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

工具本身复杂度不高，且已有输出 schema，返回格式无需赘述。描述覆盖了用途、参数、替换语义和误操作风险；主要缺失是与 insert/append 等替代工具的明确边界说明，但调用所需核心信息基本齐全。

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

schema 覆盖率为 0%，描述必须补偿参数语义。它逐项解释了 block_id、data_type、data 的含义，并补充了 data_type 仅支持 markdown 或 dom 这一关键限制，超出了 schema 本身提供的信息。

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?

描述明确说明“更新块内容”，并以“整块替换，不是局部 patch”进一步界定操作性质，能与 insert_block、append_block 等兄弟操作区分。但没有显式点名替代工具，因此未达到满分。

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

给出明确适用场景：“已知 block_id 时，直接替换该块内容”，并提示这是整块替换而非局部 patch。不过没有说明何时不应使用，也没有提到可选用的兄弟工具，缺少排除性指引。

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