Append Markdown

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

No annotations are provided, so the description must disclose behavioral traits. It only says 'append', implying modification, but does not mention whether content is added at the end, if it overwrites, or if it requires the document to exist. No mention of side effects, permissions, or idempotency.

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 concise (one sentence), but it lacks structure and important details. While brevity is positive, it comes at the cost of completeness. Ideally, it would include core usage context upfront.

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 the complexity of the input schema (5 parameters, including a nested 'placement' object) and no annotations or output schema, the description is too sparse. It does not explain required parameters, the effect of 'placement', or what happens if the document does not exist.

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?

Only 40% of schema parameters have descriptions (markdown and placement). The description does not elaborate on any parameters. For example, it does not explain 'workspaceId', 'docId' (beyond being required), or 'strict'. The description adds no value beyond the input schema.

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 uses a specific verb 'Append' and clearly identifies the resource 'markdown content to an existing AFFiNE document'. It distinguishes from sibling tools like 'create_doc_from_markdown' (which creates new docs) and 'append_block' (which likely appends blocks, not raw markdown). However, it does not explicitly mention alternatives.

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 does not provide any guidance on when to use this tool vs alternatives such as 'append_block', 'append_paragraph', or 'create_doc_from_markdown'. It neither states prerequisites nor contrasts with other append-like tools.

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