penpot_find_shapes

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

With no annotations, the description details return fields (id, type, name, position/size, linkState), filter combination logic (AND), and the subtree caveat. Does not cover performance or auth, but sufficient for a read-only search.

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?

Front-loads purpose and usage, then details parameters and returns. Slightly verbose in enumerating linkState values, but all sentences add value.

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 9 parameters, no output schema, and no annotations, the description covers input filters and output structure well. Missing details on limit behavior and error conditions, but adequate for a search tool.

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 0%, but the description explains all filter parameters (type, name, nameContains, textContains, isComponentInstance, isRoot) and their semantics. Does not explain fileId, pageId, limit, but those are understandable from context or 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?

Clearly states the verb 'Search' and resource 'shapes on a page', distinguishes from the sibling penpot_get_file_snapshot by positioning as an alternative to walking the tree.

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?

Explicitly describes when to use (to find shapes by predicates instead of tree walking) and provides an alternative penpot_get_shape for full subtree. Lists all filters and explains omitting filters lists all shapes.

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