Search NYC Open Data catalog

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds valuable context by listing the exact fields returned and the downstream workflow purpose. It does not mention rate limits or pagination semantics, which would be a further improvement.

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?

Three tight sentences with no filler: scope, return payload, then the workflow directive. The most actionable guidance (use before query_dataset) is placed last as a clear call to action.

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 an output schema present, the description need not explain return values, and the annotations carry the safety profile. Combined with 100% schema coverage, everything an agent needs to invoke this tool and route correctly afterward is present.

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 100%, so every parameter (query, limit, offset, category, include_columns) is already fully documented in the schema with examples and ranges. The description only restates the keyword-search nature of the query parameter, adding no syntax or format detail beyond 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?

States a specific verb (search) and resource (NYC Open Data catalog), names the host domain, and enumerates what is returned (ids, names, descriptions, dates, column names). It is clearly distinguishable from the query sibling, which executes queries rather than discovering datasets.

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?

Explicitly directs the agent to 'use this first to find a dataset id and its columns before calling query_dataset', establishing a clear ordering relationship with the named alternative. The condition that selects this tool over query_dataset is stated outright.

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