Skip to main content
Glama
vandreus

UniFi MCP Server

by vandreus

find_devices_by_name

Locate UniFi network devices by their name to manage and monitor your infrastructure through the UniFi Cloud API.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The main handler function for the 'find_devices_by_name' tool. It normalizes the query, retrieves all devices using unifi.listAllDevices(), filters devices by name or model containing the query, and returns a formatted JSON response with search results.
    handler: async ({ query }) => {
      const queryLower = query.toLowerCase();
      const allDevices = await unifi.listAllDevices();
      const devices = allDevices.data || [];
    
      const matches = devices.filter(d => {
        const name = (d.name || d.model || '').toLowerCase();
        return name.includes(queryLower);
      });
    
      return {
        content: [{
          type: 'text',
          text: JSON.stringify({
            searchQuery: query,
            matchCount: matches.length,
            matches
          }, null, 2)
        }]
      };
    }
  • Zod input schema for the tool, requiring a 'query' string parameter.
    schema: z.object({
      query: z.string().describe('The search query for device name')
    }),
  • src/server.js:28-32 (registration)
    Registration of the deviceTools module (which contains 'find_devices_by_name') into the MCP server via registerToolsFromModule, which calls server.tool() for each tool in the module.
    registerToolsFromModule(networkTools);
    registerToolsFromModule(deviceTools);
    registerToolsFromModule(clientTools);
    registerToolsFromModule(protectTools);
    registerToolsFromModule(accessTools);
  • src/server.js:16-25 (registration)
    Helper function used to register each tool from a module object like deviceTools, by invoking MCP server's tool() method with name, schema, handler, and description.
    const registerToolsFromModule = (toolsModule) => {
      Object.entries(toolsModule).forEach(([name, toolConfig]) => {
        server.tool(
          name,
          toolConfig.schema,
          toolConfig.handler,
          { description: toolConfig.description }
        );
      });
    };
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vandreus/Unifi-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server