search_series

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

With no annotations, the description must fully convey behavioral traits. It mentions returning 'most popular matches' (sorting) and includes frequency, units, and observation range. However, it does not explain pagination, error handling, or how the 'limit' parameter affects results. The description adds value beyond the schema but is not fully transparent.

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 two sentences with no extraneous information. It front-loads the core action and purpose, then adds value by specifying the output purpose ('so an agent can pick the right series_id'). Efficient and well-structured.

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 two parameters and the existence of an output schema (not shown), the description adequately covers the tool's purpose and main output. It could include more on how search results are ordered or pagination, but overall it is fairly complete for a search 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?

Schema coverage is 0%, so the description must clarify parameters. It explains that 'query' is a keyword search, but does not describe the 'limit' parameter beyond its schema presence. For a tool with 2 parameters, this is partial but sufficient for basic understanding.

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 uses a specific verb 'Search' and resource 'FRED catalog for series'. It clearly states the output: 'most popular matches with their frequency, units, and observation range', which helps distinguish from siblings like 'get_series' that retrieve a single series by ID.

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 implies this tool is for finding a series_id when you don't know it, but it doesn't explicitly state when not to use or compare to alternatives like 'get_series' or 'get_series_latest'. The phrase 'so an agent can pick the right series_id' gives context, but lacks explicit exclusion guidelines.

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