wiki_create_node_with_markdown

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

With no annotations provided, the description carries the full transparency burden. It explicitly discloses the internal chain: '上传 Markdown → 转换为 docx → 移入知识库指定位置', which is valuable behavioral information. It omits failure modes or permissions but is notably transparent about the workflow.

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 compact and well-structured: one sentence for the primary action and internal steps, one for the use case. There is no redundant information, and key information is front-loaded.

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 explains the core behavior and internal pipeline, which is sufficient for a moderately complex tool with no output schema. It does not cover return values or error handling, but that is not critical given the tool's straightforward creation purpose.

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?

The input schema covers 100% of parameters with descriptions, so the baseline is 3. The description does not add parameter-level details beyond what the schema already provides, but it does not need to.

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 the verb '创建' (create) and resource '文档节点' (document node) with Markdown content in a knowledge base. It distinguishes from sibling tools like wiki_create_node by emphasizing the one-step internal conversion pipeline and 'Markdown 内容'.

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?

The description provides a clear usage context: '适合需要快速创建有内容的 wiki 文档的场景' (suitable for scenarios needing quick creation of wiki docs with content). It does not explicitly mention alternatives, but the scenario guidance is sufficient for basic decision-making.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.