Edit a website section

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

Adds context about live editing and re-rendering beyond annotations (readOnlyHint=false). But does not disclose handling of invalid indices, permissions, or failure modes.

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, no fluff, front-loaded with 'Live editor', efficient and clear.

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?

Covers main functionality well, but misses edge cases (invalid index, project requirement) and does not explain return values (no output schema). Adequate for a simple edit 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?

Only index has schema description (25% coverage). Description explains index role and that heading/body are patchable, but does not clarify 'project' parameter format or constraints.

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 verb (patch/append), resource (website section), and distinguishes between updating existing by index and appending new. Among many edit tools, this is specific to site sections.

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 when to use index vs omit, but lacks explicit comparison to alternatives like set_site or add_page. Implicit differentiation is present.

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