Create Document From Markdown

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

Without annotations, the description carries the full burden. It only mentions side-effect of embedding via parentDocId but does not disclose other behaviors like required permissions, error responses, or consequences of leaving parentDocId unset (orphan doc implied but not explicit). This is insufficient for a mutation tool.

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?

Two concise sentences with no redundant information. The key feature (parentDocId) is front-loaded in the second sentence. Every sentence adds value.

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?

Given 5 parameters, no output schema, and siblings like create_doc, the description covers the main purpose and a key option, but misses important details: the purpose of workspaceId, the 'strict' parameter, and what the tool returns. It is partially complete but has gaps.

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 40% (only markdown and parentDocId have descriptions). The description adds no new parameter semantics beyond what the schema already provides. It does not explain workspaceId, title, or strict, which are undocumented in both the schema and description.

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 action: create a new document and import markdown content. It specifies the resource (AFFiNE document) and distinguishes from sibling tools like append_markdown or create_doc by mentioning importing markdown and the parentDocId embedding feature.

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 implicitly guides usage by highlighting the parentDocId option to embed and avoid orphan documents. However, it lacks explicit when-to-use or when-not-to-use guidance compared to siblings like create_doc (no markdown) or append_markdown. The context is clear but not exhaustive.

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