Search notes for a specific company by ID. Use a focused query to avoid Autotask API rate limits.
Search for notes on a specific company. Iterating across many companies trips Autotask's API threshold — scope the parent list first.
| Name | Required | Description | Default |
|---|---|---|---|
| pageSize | No | Number of results to return (default: 25, max: 100) | |
| companyId | Yes | The company ID to search notes for |
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 carries full burden. It discloses an important behavioral limitation (API threshold when iterating) beyond the basic search operation, but does not detail return format or other behaviors.
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?
Two efficient sentences: the first states purpose, the second adds critical usage guidance. No unnecessary words, each sentence earns its place.
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?
Despite lacking output schema and annotations, the description covers core functionality and key usage caveat. However, it omits details about the return value structure, which would be helpful.
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 100%, so baseline is 3. The description does not add any additional parameter information beyond the schema's own descriptions, failing to add extra semantic value.
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 it searches for notes on a specific company, distinguishing it from sibling tools like autotask_get_company_note (single note retrieval) and autotask_create_company_note (creation).
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 explicitly warns against iterating across many companies due to API thresholds and advises scoping the parent list first, providing clear usage context and a potential workflow hint.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.