Batch Create Documents

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

With no annotations, the description must disclose behavioral traits. It explains the core action (create multiple docs) and optional parenting, but does not mention error handling, idempotency, permissions, or side effects. Some basic transparency is present but gaps remain.

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, front-loaded with the primary action, and every sentence adds value. No fluff or repetition.

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 schema covers parameter details and there is no output schema, the description covers the key aspects: batch creation, parenting, and limits. It does not specify return values or error states, but for a straightforward creation tool, this is nearly complete.

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 50% because 'workspaceId' lacks a description. The description adds context for parentDocId but not for workspaceId. For the docs parameter, the schema already describes its properties. The description does not fully compensate for the undocumented parameter.

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 it creates multiple AFFiNE documents in a single call, specifies the optional parent linking, and sets a max batch size of 20. This distinguishes it from the sibling 'create_doc' which creates a single document.

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 mentions the max batch size (20) which is a usage constraint, but does not explicitly explain when to use this tool versus alternatives like 'create_doc' or provide any prerequisites or exclusions.

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