get_topic_partition_lineage

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

With no annotations, the description carries the full burden. It only states the basic action, omitting any details about read-only nature, required permissions, side effects, or output behavior. The presence of an output schema partially compensates for return value info, but behavioral traits remain opaque.

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 a single, concise sentence with no superfluous words. It is front-loaded and efficiently communicates the core purpose. However, it could be slightly enhanced with minimal additional context without losing conciseness.

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 lack of annotations and the presence of many similar sibling tools, the description is insufficiently contextual. It does not explain what lineage means, what the output structure looks like (despite an output schema), or any edge cases. The agent would need external knowledge to fully utilize this tool.

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 input schema has 0% description coverage, and the tool description adds no parameter guidance. The parameters 'topic_name' and 'partition' are listed but without format, constraints, or examples, leaving the agent to infer meaning from names alone.

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 action ('Get') and the resource ('lineage information for a topic partition'). It distinguishes the tool from sibling 'get_topic_lineage' by specifying partition-level granularity. However, it does not elaborate on what 'lineage information' entails.

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?

No guidance is provided on when to use this tool versus alternatives like 'get_topic_lineage' or 'get_producer_lineage'. There is no mention of prerequisites, context, or exclusions.

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