search_spellbook

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

With no annotations provided, the description must fully disclose behavioral traits. It states the tool provides 'Zero-credit schema discovery' (indicating no cost), but does not confirm read-only nature, side effects, or what happens on failure. The zero-credit hint is valuable but not comprehensive.

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 extremely concise at 14 words across two sentences. Every word is informative, front-loading the core purpose and a distinguishing feature (zero-credit). No unnecessary information.

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 simplicity of the tool (one parameter, output schema exists), the description covers the essential function and a key behavioral trait (zero-credit). It does not explain return values or pagination, but the output schema likely provides that. Overall sufficiently complete for its scope.

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 description coverage is 0%, so the description must compensate. It implies the 'keyword' parameter is a search term for table names, but does not provide examples, format, or allowed patterns. For a single required string parameter, the added context is adequate but not detailed.

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 clearly states the tool searches 'GitHub Spellbook for official tables (.sql/.yml)', using the specific verb 'search' and identifying the resource (official tables) and data format. This distinguishes it from siblings like get_spellbook_file_content and get_table_schema.

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?

The description implies usage for schema discovery without credit cost ('Zero-credit schema discovery'), but does not explicitly state when to use this tool vs alternatives (e.g., when you know the exact table name, use get_table_schema instead). No when-not-to-use guidance is provided.

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