ground_kafka_topic

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

No annotations are provided, so the description carries the full burden. It discloses the sampling behavior, the requirement of a reachable broker and populated topic, and what it returns. This goes beyond a simple read assertion, though it does not mention failure modes or potential side effects (which are minimal for a read/sampling tool).

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 main function and then providing usage and requirements. Every sentence earns its place with actionable information and no 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?

With 5 parameters, no output schema, and no annotations, the description covers the tool's purpose, return type, prerequisites, and downstream usage. It lacks details on error handling or parameter-dependent behavior, but for the tool's complexity and available structured fields, it is sufficiently complete. The requirement that 'the topic populated' hints at failure conditions.

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 only 40%, and the description does not compensate. Parameters like topic, sample_size, and watermark_delay_seconds lack explanation beyond their raw schema names. The description mentions 'event_time' indirectly but doesn't explain how it is used. No additional meaning is provided over the 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?

The description starts with a specific verb ('Discover') and identifies the exact resource ('Kafka topic's schema') and method ('by sampling its messages'). It clearly distinguishes itself from siblings (generate_flink_job, deploy_to_kafka) by stating its result is 'a schema + sample rows ready to pass to generate_flink_job'.

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 explicitly states when to use it: 'Use when the user references a real topic and you don't have its schema.' It does not explicitly mention alternatives or when not to use, but the usage scenario is clear and contextual. The sibling tools are different enough that no exclusion is needed.

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