peaka_create_semantic_table

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

Annotations (readOnlyHint=false, destructiveHint=false) indicate this is a non-read, non-destructive operation. Description adds that the table is a queryable view over an existing saved query, clarifying its nature beyond annotations.

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?

Two clear paragraphs: first explains core purpose, second gives usage guidelines. Front-loaded with the main action. No redundancy or filler.

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?

Covers prerequisites and parameter sources. Lacks return value information (e.g., whether it returns an ID or success status), but given no output schema, this is a minor gap. Overall sufficient for an agent to invoke correctly.

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 100% with descriptions for all parameters. Description adds workflow context for obtaining parameter values (e.g., how to get queryId, catalogId, projectId), which goes beyond the schema descriptions.

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 the verb (create), the resource (semantic table backed by a saved query), and the context (catalog/schema/table become a queryable view). Distinguishes from sibling tools like peaka_create_semantic_catalog and peaka_delete_semantic_table.

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 obtain queryId via peaka_create_query or peaka_list_queries, catalogId via peaka_create_semantic_catalog or peaka_list_catalogs, and projectId via peaka_list_projects. Provides a clear workflow. Lacks explicit when-not-to-use, but implied by prerequisites.

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