List Surface Elements

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

No annotations provided, so description carries full load. It reveals return format (raw xywh strings, parsed bounds, serialized Y.Text) but does not mention read-only nature, performance impact, or error scenarios. Adequate but not comprehensive.

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 sentences, front-loaded with purpose, additional details in second sentence. No redundant words. Efficient and scannable.

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 no output schema, description partially covers return values (bounds, serialized Y.Text). Lacks pagination, limits, or ordering info, but for a filtered list tool, it is reasonably complete. Could mention if results are sorted or limited.

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 coverage is 100% with descriptions for all 4 parameters. Description adds 'Optional filters by element type or id', which mirrors the schema but does not deepen meaning. Baseline 3 is appropriate.

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?

Clear verb 'list' and resource 'surface elements'. Description specifies the canvas type (AFFiNE edgeless) and element types, differentiating from sibling tools like add/delete/update_surface_element.

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?

Describes optional filters but no explicit when-to-use or when-not-to-use. Implied usage as a retrieval tool, but lacks guidance compared to siblings like 'get_edgeless_canvas' or 'add_surface_element'.

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