cite

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explicitly explains the snapshot timestamp default, the effect of current=True, and the JSON return structure with fields url, rid, and is_snapshot, backed by illustrative examples. This goes beyond a simple definition and fully informs the user.

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 well-organized with Args, Returns, and Examples sections. Each sentence adds meaningful information, and the examples clarify both modes without redundancy. Despite its length, it is concise and purposeful.

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?

For a simple two-parameter tool, the description is complete: it covers purpose, parameter semantics, return format, and behavior through examples. The output schema is effectively described via the Returns section, making the tool self-contained and easy 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?

The schema provides no parameter descriptions (0% coverage), so the description must compensate. It does so thoroughly: rid is defined as the RID of the entity, and current is explained with its default and effect on the URL. The examples further illustrate the parameter values and outcomes.

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 begins with a specific verb and resource: 'Generate a citation URL for a catalog entity.' It further clarifies the scope with examples of entity types and provides examples of the output, clearly distinguishing this tool from sibling tools focused on data manipulation.

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 clear conditional guidance: 'Use current=True for a link to the live data.' It explains the default snapshot behavior and how to override it. While it doesn't mention alternative tools, none of the siblings serve a citation purpose, so the context is sufficient.

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