Add Surface Element

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

No annotations are provided, so the description carries full burden. It discloses that non-applicable style fields are reported in an 'ignored' list, and explains connector endpoint snapping behavior. However, it does not detail return values, auth requirements, or potential side effects beyond creation.

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 three sentences, front-loading the action and supported types. It is concise but could be better structured by separating usage guidance from behavioral notes. No unnecessary words.

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 30 parameters and no output schema, the description covers core functionality and key details like ignored fields and color preferences. However, it lacks explanation of the full response structure (e.g., created element ID) and does not mention pagination or limits. Adequate for a creation tool but not fully comprehensive.

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?

With 100% schema coverage, the description still adds value by providing default values, color palette recommendations, and behavioral clarifications for connector positions. It clusters parameters by element type, enhancing understanding beyond the schema alone.

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 adds shapes, connectors, text, or groups to the AFFiNE edgeless canvas. It lists specific types and mentions diagram building, effectively distinguishing from siblings like update_surface_element by referencing the 'ignored' list behavior.

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 advises using the tool 'for building diagrams programmatically' and references update_surface_element for the 'ignored' list. It provides context for when to use, but does not explicitly state when not to use or enumerate alternatives among the many sibling tools.

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