Skip to main content
Glama

get-sdwan-config

Retrieve a specific SD-WAN configuration by its ID.

Instructions

Get a specific SD-WAN configuration by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesSD-WAN config ID

Implementation Reference

  • src/index.ts:137-139 (registration)
    Registration of the 'get-sdwan-config' tool using the MCP tool() function with schema and handler.
    tool("get-sdwan-config",
      "Get a specific SD-WAN configuration by ID",
      getSdwanConfigSchema.shape, wrapToolHandler(getSdwanConfig));
  • Zod schema for get-sdwan-config: requires 'id' (string) describing the SD-WAN config ID.
    export const getSdwanConfigSchema = z.object({
      id: z.string().describe("SD-WAN config ID"),
    });
  • Handler function getSdwanConfig: makes a GET request to /sd-wan-configs/{id} and returns the data.
    export async function getSdwanConfig(params: z.infer<typeof getSdwanConfigSchema>) {
      const response = await unifiClient.get<{ data: unknown }>(`/sd-wan-configs/${params.id}`);
      return response.data;
    }
  • Import of getSdwanConfigSchema and getSdwanConfig from src/tools/sdwan.ts into the registration file.
    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?

No annotations are provided, so the description must disclose behavioral traits. It only says 'Get...by ID' and does not mention that it is a read-only operation, authentication requirements, error behavior, or rate limits. This is insufficient for safe agent usage.

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, concise sentence that conveys the core purpose without any extraneous information. Ideal structuring for a simple tool.

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

Completeness3/5

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

The description lacks information about the return value. Since there is no output schema, the agent needs to know what the response contains. It also doesn't clarify that this gets a single config versus list-sdwan-configs returning multiple.

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

Parameters3/5

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

Schema coverage is 100% with the 'id' parameter described as 'SD-WAN config ID'. The description rehashes 'by ID' but adds no extra meaning beyond the schema. Baseline 3 is appropriate.

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 'Get' on the resource 'specific SD-WAN configuration' with scope 'by ID'. It distinguishes from sibling tools like list-sdwan-configs (list) and get-sdwan-config-status (status).

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 alternatives. With many sibling tools, explicit context about when to use get-sdwan-config vs list-sdwan-configs or get-sdwan-config-status is missing.

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