Lists physical locations stored in phpIPAM, with an optional limit to control results. Get site information for IP address management.
List physical locations from phpIPAM.
CONTEXT OPTIMIZATION: Limited to 20 results by default.
Args: limit: Maximum number of locations to return (default: 20, max: 1000)
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v0.3.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description carries the full burden. It does disclose a behavioral trait beyond the schema: 'Limited to 20 results by default' and a max of 1000 via the limit parameter. However, it does not discuss auth, output format, pagination behavior, or error cases.
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 compact and front-loaded with the purpose. The context note and parameter explanation are direct and contain no filler.
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 simple list operation with one optional parameter and an output schema, the description is largely complete. The only meaningful gap is the absence of guidance relative to sibling list tools, but correct invocation is fully supported.
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 0%, and the description fully compensates by defining limit as 'Maximum number of locations to return' with both a default and a maximum. This adds real meaning beyond the bare input 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?
States a specific verb and resource: 'List physical locations from phpIPAM.' The resource 'locations' clearly distinguishes it from sibling list tools such as list_sections, list_nameservers, list_vlans, and list_vrfs.
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 is provided about when to use this tool versus alternatives. It does not mention exclusions, prerequisites, or why list_locations would be preferred over related list tools. Usage is only implied by the name and description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.