list_all_clients
Retrieve all connected client devices from your UniFi network for monitoring and management purposes.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/clients.js:12-17 (handler)The handler function that executes the list_all_clients tool logic: calls the unifi.listAllClients helper and returns the clients data as formatted JSON text content.
handler: async () => { const clients = await unifi.listAllClients(); return { content: [{ type: 'text', text: JSON.stringify(clients, null, 2) }] }; } - src/tools/clients.js:11-11 (schema)Zod input schema for the tool: empty object (no input parameters required).
schema: z.object({}), - src/server.js:28-32 (registration)Registers the clientTools object (containing list_all_clients) with the MCP server via registerToolsFromModule.
registerToolsFromModule(networkTools); registerToolsFromModule(deviceTools); registerToolsFromModule(clientTools); registerToolsFromModule(protectTools); registerToolsFromModule(accessTools); - src/tools/clients.js:9-18 (registration)Defines and exports the list_all_clients tool configuration (description, schema, handler) as part of clientTools.
list_all_clients: { description: 'List all connected clients across all hosts and sites', schema: z.object({}), handler: async () => { const clients = await unifi.listAllClients(); return { content: [{ type: 'text', text: JSON.stringify(clients, null, 2) }] }; } }, - src/unifi-client.js:125-128 (helper)Helper function listAllClients that performs the API call to fetch all clients from the UniFi Cloud API (/v1/clients) and returns the response data.
export async function listAllClients() { const response = await cloudApi.get('/v1/clients'); return response.data; }