Skip to main content
Glama
FortiManager MCP Server

FortiManager MCP Server

by rstierli

get_device_sdwan

Retrieves a managed device's local SD-WAN configuration from FortiManager's device database, including members, zones, health-checks, and steering rules, when no wanprof template is assigned.

Instructions

Get a managed device's SD-WAN configuration from FortiManager's device DB.

Unlike get_sdwan_template (which reads wanprof templates in an ADOM), this reads the SD-WAN config local to the device itself -- members/zones, health-checks and service (steering) rules -- from the device database FortiManager keeps in sync with the FortiGate. Use this when a device runs SD-WAN but has no wanprof template assigned (list_sdwan_templates returns nothing) yet you still need its members, zones and steering rules.

Args: device: Managed device name (e.g. "branch1") vdom: VDOM name (default: "root")

Returns: dict with keys: - device, vdom - sdwan: raw system/sdwan config object (health-check password stripped -- see _SDWAN_SECRET_FIELDS) - summary: condensed members/zones/health-checks/service rules - error / error_code: on failure

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "device": "<device>"
    },
    "name": "get_device_sdwan"
  }
}

Input Schema

NameRequiredDescriptionDefault
vdomNoroot
deviceYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.12.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does well: it names the data source (device DB kept in sync with the FortiGate), the config sections read (members/zones, health-checks, service rules), and discloses secret redaction (``password`` stripped per _SDWAN_SECRET_FIELDS) plus the error/error_code failure shape. It stops short of stating permission/auth requirements or whether results can lag the live device, so not a full 5.

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

Conciseness4/5

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

Front-loaded with the core distinction from the template-based sibling before the details, which is the right ordering. The Args/Returns block is somewhat verbose and partially duplicates the output schema, but no sentence is pure filler.

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

Completeness5/5

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

For a two-parameter read tool with an output schema, the description covers purpose, sibling differentiation, both parameters, data provenance, redaction behavior, and failure keys. Nothing an agent needs in order to call it correctly and interpret the result is missing.

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 description coverage is 0%, so the description must supply parameter meaning; it documents ``device`` as the managed device name with an example ("branch1") and ``vdom`` with its default of "root". That marginally exceeds the bare schema titles but adds no guidance on vdom semantics (e.g. multi-VDOM devices, invalid vdom behavior), leaving the compensation partial.

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?

States a specific verb and resource ("Get a managed device's SD-WAN configuration from FortiManager's device DB") and explicitly contrasts the scope with the sibling ``get_sdwan_template`` (device-local config vs. ADOM wanprof templates). An agent can distinguish it from get_sdwan_template, get_sdwan_template_config and get_device_sdwan_monitor without opening any schema.

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

Usage Guidelines5/5

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

Gives an explicit selection condition: use it when a device runs SD-WAN but has no wanprof template assigned and ``list_sdwan_templates`` returns nothing. It also names the alternative tool and the condition under which that alternative applies, which is exactly the when/when-not guidance needed.

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

Deploy Server

Other Tools