Append Paragraph

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

The description indicates a mutation action ('append') but provides no additional behavioral details such as whether the operation is reversible, requires permissions, or affects formatting. With no annotations, the description's brief statement is insufficient.

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 a single sentence with no wasted words. However, it is overly terse; a slightly expanded structure would be more helpful.

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 low complexity and lack of output schema, the description barely covers essential context. It does not differentiate from similar tools or clarify edge cases, leaving the agent without sufficient guidance.

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 has 0% parameter description coverage, and the description adds no meaning beyond parameter names (workspaceId, docId, text). It does not explain expected formats, constraints, or purposes.

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 'Append a text paragraph block to a document', identifying the action and resource. However, it does not distinguish from sibling tools like 'append_block' or 'append_markdown', which could lead to confusion.

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?

No explicit guidance on when to use this tool versus alternatives. The description implies use for adding text paragraphs but does not specify exclusions or context.

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