peaka_list_catalogs

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

Annotations already provide readOnlyHint=true, and the description aligns with that by stating 'list'. No additional behavioral details beyond the annotation are provided, and no contradictions.

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 two sentences, front-loading the purpose first and usage guidance second. Every sentence is necessary, no redundancy or 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?

For a simple listing tool with one required parameter and readOnlyHint, the description covers purpose, return content, and usage prerequisites. No output schema exists, but the description mentions what is returned, making it complete.

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?

The single parameter projectId is fully described in the schema (100% coverage), so the description adds limited value. It does add context about when to call peaka_list_projects to obtain the projectId, which is helpful but not essential for parameter meaning.

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 verb 'list' and resource 'catalogs', distinguishing it from sibling tools like peaka_list_schemas and peaka_list_tables. It specifies what is returned: catalog names, types, and connection info.

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 instructs to call peaka_list_projects first if projectId is unknown, and to ask the user for the project. Also advises remembering the projectId for subsequent calls. This provides clear when-to-use and prerequisites.

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