search_addresses

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

With no annotations, the description bears the full burden of behavioral disclosure. It does mention the default result limit (10) and max limit (50), but it does not disclose other important behaviors such as exact vs partial matching, pagination, or whether both IP and hostname results are returned. This is minimal context 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 extremely concise and well-organized: a clear one-sentence purpose, a brief context note, and a straightforward Args list. Every sentence adds value with no unnecessary detail.

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?

The description covers the core purpose and parameters, and an output schema exists so return values need not be explained. However, it leaves gaps around matching behavior and does not clarify the distinction from 'search_hostname', making it only partially 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?

The input schema has 0% description coverage for parameters, but the description's 'Args' section provides clear explanations for both 'ip_or_hostname' and 'limit', including a default and max value for limit. This effectively compensates for the schema's lack of descriptions.

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 'Search for IP addresses or hostnames in phpIPAM,' which specifies a clear verb and resource. However, it does not explicitly differentiate from the sibling tool 'search_hostname' or clarify when this broader search is preferable, so it lacks full sibling distinction.

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 provides no guidance on when to use this tool versus alternatives like 'search_hostname' or 'search_subnets'. The only contextual note ('Limited to 10 results by default') addresses result limits, not tool selection, leaving the agent without explicit direction.

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