get_migration_flows

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

Annotations already declare read-only/idempotent. The description adds valuable behavioral context: potential IRS suppression for low returns, AGI amounts in thousands, and the array of flow records with fields. This exceeds what annotations provide.

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?

Four sentences, front-loaded with the core purpose. No filler—each sentence adds meaningful information (what, definitions, return structure, privacy caveat, source).

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 absence of an output schema, the description adequately specifies the return array contents (FIPS, area name, returns, exemptions, AGI) and data caveats (suppression). Combined with schema, it is fully complete for a data retrieval 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 covers all 6 parameters with descriptions (100% coverage). The description adds meaning by detailing AGI units (thousands) and clarifying inflow/outflow semantics, which complements but does not duplicate schema info.

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 retrieves top inflow/outflow areas for a county or state, ranked by tax returns or AGI. It also defines inflow and outflow, which distinguishes it from sibling tools like get_migration_summary or get_migration_trends.

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?

Provides clear context for when to use (ranked migration areas by direction and level) but does not explicitly mention alternative tools or exclusion criteria. The focus on 'top areas' implies a specific use case, though contrast with siblings is absent.

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