Skip to main content
Glama
Sign In
pihole-mcp

pihole-mcp

by chris2ao
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

list_clients

Retrieve configured Pi-hole clients by IP, MAC, hostname, CIDR, or interface and show their assigned groups. Use it to inspect client-to-group mappings.

Instructions

List configured clients (IP, MAC, hostname, CIDR, or interface) and their groups.

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_clients"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.1.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden, and it does disclose the composition of the result (identity types plus group membership). It stops short of confirming the operation is a pure read, stating that all configured clients are returned unfiltered, or noting any ordering/pagination behavior.

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?

A single front-loaded sentence with no filler words and no redundancy. Every clause (verb, resource, identity fields, group association) earns its place.

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 zero-parameter list tool with an output schema present, the description need not explain return values or pagination, and the schema covers the (empty) input. It is essentially complete, with only the read-only nature left to inference from the verb 'List'.

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 tool takes zero parameters, so there is nothing for the description to disambiguate; the baseline for a parameterless tool is 4. The parenthetical field list adds modest value by framing what each client record contains.

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

Purpose4/5

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

Clear verb+resource: 'List configured clients' with the identity fields (IP, MAC, hostname, CIDR, interface) and their groups spelled out. It does not, however, name or contrast itself with the sibling get_top_clients or get_client_history, so an agent must infer the distinction itself.

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

Usage Guidelines2/5

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

No explicit when-to-use guidance, no prerequisites, and no mention of alternatives despite several close siblings (get_top_clients, get_client_history, get_client_suggestions). The qualifier 'configured' weakly implies a configuration listing rather than statistics, but that is inference, not 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