Search for products in Autotask using optional filters like name, active status, and page size.
Search for products with optional filters
| Name | Required | Description | Default |
|---|---|---|---|
| isActive | No | ||
| pageSize | No | Number of results to return (default: 25, max: 100) | |
| searchTerm | No | Search term for product name |
Changes observed during successful MCP inspections.
v2.18.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description should disclose behavior. It mentions optional filters but omits details like pagination, default behavior when no filters are applied, sorting, or search matching logic. This is insufficient for a search tool.
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 a single sentence, concise, but could be slightly expanded to include key behavioral details without being verbose.
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 tool with three optional parameters and no output schema, the description lacks context on return format, pagination limits, and search behavior. It is incomplete for effective use.
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 67% (two of three parameters have descriptions). The tool description does not add meaning for 'isActive', which has no schema description, and does not enhance understanding of the other parameters beyond what is in 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?
The description states the tool searches for products, which is clear. However, it does not specify the type of products or differentiate from other search tools like autotask_search_services, but the entity name 'products' is distinct enough.
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?
No guidance on when to use this tool versus alternatives like autotask_get_product or other search tools. The description only states the action without context for selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.