peaka_query_golden_sqls

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

Annotations already provide readOnlyHint=true, so agent knows it's safe. Description adds that the tool queries a vector store and advises to remember projectId. No contradictions. Could mention return limits but overall good.

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 concise sentences with front-loaded main action, then conditional logic. Every sentence is necessary and clear. No wasted words.

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?

While the description covers purpose and usage, it lacks details about return format (e.g., what exactly is returned, whether it's one or multiple matches). Without output schema, more specificity on the result would improve completeness.

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 has 2 required parameters with 50% coverage (projectId described, query not). Description adds context: projectId can be obtained via peaka_list_projects, and query is a question to search. This partially compensates but does not fully describe query format.

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 it queries question/sql pairs from Peaka's golden sql vector store, using specific verb 'query' and resource 'golden sql vector store'. It distinguishes from siblings like peaka_execute_sql_query and peaka_list_queries by focusing on retrieval of existing pairs.

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?

Explicit guidance: use this tool first to find an existing matching query; if not found, use other tools. Also provides prerequisite: if projectId is unknown, call peaka_list_projects first. This clearly tells when to use and when not to use.

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