Sayfayı getir

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the safety profile is covered. The description adds behavioral detail about what each mode returns (outline summary with IDs/types/slots vs full draftData JSON), which is useful beyond the annotations.

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 with clear structure. The description front-loads the purpose and immediately explains modes, including a practical hint for update_page. No fluff.

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?

Without an output schema, the description clearly explains what each mode returns (outline with IDs and short text; full with complete JSON). It also notes the default mode and the use case for update_page, making the behavior fully transparent despite the absence of an output schema.

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 describes 'page' with format (hex or slug), and description explains the 'mode' parameter including its default and meaning of both values. Since schema coverage is 50% (only 'page' described), the description effectively compensates and adds semantic value.

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 it returns a page draft, distinguishes two modes (outline vs full) and explicitly connects to update_page for ID retrieval. This goes beyond the tool name and clarifies the exact resource and 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?

It explains when to use mode=outline (to get IDs for update_page) and mode=full for complete JSONapis. While it doesn't explicitly say when not to use this tool vs siblings, the context is clear from the mode explanations and the sibling list (update_page, delete_page, etc.).

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