IvedaAI: Filter

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

Discloses response structure (status, truncated/timedOut flags) and critical update behavior (refuses partial bodies, field mapping differences). Annotations already indicate destructive/read-write nature, but the description adds substantive detail about what happens during calls.

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 endpoint-based structure is efficient and scannable, with each operation clearly listed. It's slightly long due to the many endpoints and notes, but every line adds value, such as the response flag explanation and the body field caveat.

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 there is no output schema, the description compensates by explaining the response JSON structure and edge cases like truncation. It covers all five operations, parameter details, and required fields, and references ivedaai_get_schema for comprehensive field schema, making it a complete guide for using this 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?

The description enumerates the query parameters (offset, page, pageSize, sort, etc.), path parameter (filterId), and required body fields (name, type) for create/update. This goes well beyond the generic schema's generic 'query' and 'body' properties, giving explicit meaning to each parameter.

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 identifies this as the Filter resource with CRUD operations, listing all five endpoints. It distinguishes itself from sibling tools by focusing on 'filter' operations with specific verbs like List, Create, Delete, Find, and Update.

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 per-operation guidance, including query parameters for listing, path parameter for id-based operations, and body requirements for create/update. The note about GET vs PUT field mapping and the warning about refusing partial bodies gives context for when to use each operation, though it doesn't explicitly compare to alternative tools.

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