Create Document From Markdown

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

Annotations already indicate this is a mutating (readOnlyHint=false), non-destructive (destructiveHint=false) operation. The description adds value by explaining the behavioral consequence of using `parentDocId`—the doc becomes visible in the sidebar instead of being an orphan. This context goes beyond the annotations and enhances transparency.

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 two sentences long, front-loads the primary purpose, and includes a practical tip without any fluff. Every word earns its place.

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 covers the core function and a key parameter, but it omits explanation of `strict` and doesn't clarify when to choose this tool over siblings. With an output schema present, return values are covered, but the missing parameter context and usage positioning leave gaps for a 5-parameter tool.

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 description coverage is 60%, leaving `title` and `strict` undocumented. The description only rehashes the `parentDocId` behavior already present in the schema, adding no new meaning. The ambiguous `strict` parameter is not explained, so the description fails to compensate for the schema gaps.

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 tool creates a new AFFiNE document and imports markdown content, which is a specific verb+resource. However, it doesn't explicitly distinguish this tool from siblings like `create_doc` or `append_markdown`, so it's clear but not fully differentiated.

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 conditional usage guidance for `parentDocId`, explaining how to embed the new doc in the sidebar. But it doesn't explicitly state when to use this tool over alternatives like `create_doc` or `replace_doc_with_markdown`, so guidance is implied rather than direct.

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