open_editor

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

Reveals editor mode and the effect of providing a file vs not. Lacks details on permissions, blocking behavior, or return values. With no annotations, description carries burden but is minimally adequate.

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 key information, no unnecessary words. Each sentence adds 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?

For a tool with one optional parameter and an output schema, the description covers essential use cases. Missing details on side effects or the fact that it launches KLayout, but name and context suffice.

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?

Despite 0% schema description coverage, the explanation of file_path's optionality and effect (edit vs create blank) adds meaning beyond the schema. Does not specify format or path conventions but schema is simple.

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?

Description clearly states the verb 'open' and resource 'KLayout in editor mode', and distinguishes between editing a file vs creating a blank layout. It differentiates from sibling 'open_layout' by specifying editor mode.

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?

Provides clear usage context: with a file to edit it, without for a blank layout. Does not explicitly state when not to use or mention alternatives, but the context is sufficient.

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