get_topic_metrics

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

With no annotations, the description carries the full burden of behavioral disclosure. It implies a read-only operation ('Returns'), which is acceptable for a metrics tool, but it does not disclose other behaviors such as aggregation across brokers, pagination limits, or any potential performance implications. It adds minimal value beyond the obvious read semantics.

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, front-loaded sentence that directly states the core function. It is appropriately sized for the tool's simplicity and contains no filler or redundant information.

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 tool has four parameters, an output schema, and no annotations, the description is too sparse. It fails to explain any parameter semantics, provides no usage context, and does not mention the output schema or return format. The existence of an output schema reduces some burden, but the missing parameter guidance and usage context make it incomplete for correct invocation.

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 schema has 0% description coverage, so the description must compensate. However, it mentions none of the four parameters (topic_name, limit, broker_id, include_raw) and offers no explanation of their roles or constraints. This is a significant gap for a tool with a required parameter and three optional ones, leaving the agent without crucial semantic context.

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 tool returns JMX Exporter metrics for a Kafka topic, specifying the verb 'Returns' and the resource type. It differentiates from siblings like get_broker_metrics (broker-level) and describe_topic (configuration/description), making the purpose unambiguous.

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 provides no guidance on when to use this tool versus alternatives such as get_broker_metrics or describe_topic. There are no explicit conditions, exclusions, or mentions of sibling tools, leaving the agent to infer selection based solely on the name and brief description.

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