list_hosts
Retrieve a list of connected devices and clients on your UniFi network to monitor activity and manage access.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/network.js:38-43 (handler)The handler function for the 'list_hosts' MCP tool. It invokes unifi.listHosts() to fetch the list of UniFi hosts and returns the result formatted as a JSON text content block.
handler: async () => { const hosts = await unifi.listHosts(); return { content: [{ type: 'text', text: JSON.stringify(hosts, null, 2) }] }; } - src/tools/network.js:37-37 (schema)The Zod input schema for the 'list_hosts' tool, which accepts no parameters.
schema: z.object({}), - src/server.js:28-28 (registration)Registration of the networkTools module in the MCP server, which includes the 'list_hosts' tool via the registerToolsFromModule utility.
registerToolsFromModule(networkTools); - src/unifi-client.js:46-52 (helper)The helper function listHosts() that performs the actual API call to retrieve UniFi hosts from the Cloud API endpoint '/v1/hosts'.
/** * List all UniFi OS hosts (consoles) */ export async function listHosts() { const response = await cloudApi.get('/v1/hosts'); return response.data; } - src/tools/network.js:2-2 (helper)Import of the unifi-client module providing the listHosts helper function used by the tool handler.
import * as unifi from '../unifi-client.js';