describe_topic

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

The description implies a read-only profiling operation, but it does not explicitly state side effects, whether it modifies data, or any operational constraints such as rate limits. Since no annotations are provided, the description carries the burden of disclosing behavioral traits and does so only implicitly.

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 concise, front-loaded with the core purpose, and uses no unnecessary words. It efficiently communicates the tool's function and usage in two sentences.

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?

The description provides enough context for the main use case and key output aspects, but it omits explanation for the optional car parameter and does not address error cases or output schema details. Given the presence of an output schema and a second parameter, the description is not fully complete.

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 required topic parameter is explained well, but the optional car parameter is completely undocumented. With only 50% of parameters described, the description does not sufficiently compensate for the schema's lack of detail, leaving ambiguity about car's purpose and usage.

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's purpose: profiling a single topic with specific outputs like sample count, time span, array arity, and value range. It also differentiates itself from siblings by framing it as a pre-query confirmation step using names from search_topics.

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 says when to use this tool: to confirm a topic is correct and to check whether its values array has more than one element before querying in bulk. It also directs the user to pass the exact name from search_topics, providing clear usage guidance.

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