Skip to main content
Glama
Sign In
phpIPAM MCP Server

phpIPAM MCP Server

by greglg45
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

list_locations

Retrieve physical locations from phpIPAM with an optional limit to control response size (default 20, max 100).

Instructions

List physical locations from phpIPAM.

CONTEXT OPTIMIZATION: Limited to 20 results by default.

Args: limit: Maximum number of locations to return (default: 20, max: 100)

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_locations"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A4/5.0
Behavior3/5

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

No annotations are present, so the description carries that burden. It adds useful behavioral context by stating the default limit of 20 and the max of 100. However, it does not explicitly state that this is a read-only operation or describe side effects, though the verb 'List' implies no mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and front-loaded with the purpose. The parameter documentation is minimal and directly useful, with no filler or redundancy, making it efficient for an agent to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple listing tool with one optional parameter and an output schema, the description covers the essential purpose and the parameter semantics. It does not mention ordering or pagination behavior, but these are not critical for a basic list operation and the output schema presumably defines return fields.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema only defines 'limit' with a default, but no description. The description adds meaningful semantics by calling it 'Maximum number of locations to return' and including both the default (20) and max (100), which goes beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's action with a specific verb ('List') and resource ('physical locations from phpIPAM'). This distinguishes it from sibling tools like list_sections and list_vlans, which list different entity types.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when a list of physical locations is needed, which is a clear context. However, it does not explicitly mention alternatives or exclusions (e.g., 'use search_addresses to find IPs'), and the 'CONTEXT OPTIMIZATION' note is more about limits than usage guidance.

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

Deploy Server

Other Tools