Read a Wiro playbook

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

The annotations already establish that this is a read-only, idempotent, non-destructive operation. The description adds useful behavioral context: each topic is self-contained for its job, and several topics can be read in one call, which affects invocation strategy. It does not need to explain return values because an output schema exists.

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?

The description is front-loaded with purpose and usage guidance before the topic catalog, and the catalog entries are informative rather than redundant. It is dense and long but largely earns its length given eight distinct topics that need to be distinguished.

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?

With a single required parameter, full schema coverage, annotations covering safety, and an output schema, the description provides everything an agent needs to choose a topic and call the tool correctly. No important invocation context is missing.

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?

Although the schema fully documents the topics parameter and its enum, the description goes well beyond the schema by explaining what each topic covers. That meaning is essential for selecting the right playbook content, especially because the enum values alone are not self-explanatory.

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?

The description gives a specific verb and resource ("Read Wiro playbooks") and explains that they are short guides covering call order, formats, and money rules for a job. This clearly distinguishes it from siblings like search_docs or get_workflow, which are not procedural playbooks.

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 explicitly says to read the relevant topic before multi-step jobs such as workflows, agent deployment, or Studio sessions, and tells the agent to use getting-started when the route or workspace is unclear. The topic catalog further routes the agent to the right playbook for each job.

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