Skip to main content
Glama

list-sdwan-configs

Retrieve all SD-WAN configurations from the UniFi network.

Instructions

List all SD-WAN configurations

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.ts:133-135 (registration)
    Registration of the 'list-sdwan-configs' tool with description and schema
    tool("list-sdwan-configs",
      "List all SD-WAN configurations",
      listSdwanConfigsSchema.shape, wrapToolHandler(listSdwanConfigs));
  • Input validation schema for list-sdwan-configs (no parameters required)
    export const listSdwanConfigsSchema = z.object({});
  • Handler function that calls the SD-WAN configs API endpoint
    export async function listSdwanConfigs() {
      const response = await unifiClient.get<{ data: unknown[] }>("/sd-wan-configs");
      return response.data;
    }
  • src/index.ts:25-29 (registration)
    Import of listSdwanConfigsSchema and listSdwanConfigs from src/tools/sdwan.ts
    import {
      listSdwanConfigsSchema, listSdwanConfigs,
      getSdwanConfigSchema, getSdwanConfig,
      getSdwanConfigStatusSchema, getSdwanConfigStatus,
    } from "./tools/sdwan.js";
Behavior2/5

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

With no annotations, the description carries full burden but only states 'List all SD-WAN configurations'. It fails to disclose pagination, size limits, authentication needs, or whether it returns full configs or summaries.

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

Conciseness3/5

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

Extremely concise but too brief to provide adequate context. A single sentence is minimal but could be expanded with useful details without becoming verbose.

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

Completeness2/5

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

Description is insufficient given no annotations or output schema. Missing details on return format, pagination, or usage context. For a list tool, this is incomplete.

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?

No parameters exist, so schema coverage is 100%. The description adds no param info, which is acceptable as there are none to document. Baseline 4 for no-param tool.

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 action (list) and resource (all SD-WAN configurations), distinguishing it from siblings like get-sdwan-config (single) and get-sdwan-config-status (status). No ambiguity.

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 guidance on when to use this tool versus its siblings, such as get-sdwan-config for a specific config. No prerequisites or context provided.

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/us-all/unifi-mcp-server'

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