quickshell_get_guide_page

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

Since annotations are absent, the description carries the burden. It discloses the read-only nature implicitly via 'Fetch', specifies the output format (Markdown), and mentions the default version and the need to list first. It does not cover error cases or authentication, but for a simple get tool this is largely sufficient.

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?

Three short sentences with no redundancy. The core action is front-loaded, followed by practical guidance. Every 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?

Given the simple nature of the tool and the presence of an output schema, the description covers the essential inputs, the default behavior, and how to obtain valid slugs. Nothing critical 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?

Schema coverage is 0%, so the description must explain parameters. It gives concrete examples for slug and states the version defaults to 'latest', fully clarifying both parameters beyond the bare 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 it fetches one Usage Guide page as Markdown, with concrete slug examples. It distinguishes from sibling list_guide_pages by instructing to call it first if slug unknown, and from other guide tools (types, examples) by the resource type.

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 says to call quickshell_list_guide_pages first if the exact slug is not known, providing a clear alternative. It also notes the version defaults to latest, which sets expectations. Does not explicitly list exclusions for other siblings, but the resource type is distinct enough.

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