mcfortigate

Overview Schema Source Related Servers Discussions Admin

List interfaces

list_interfaces

Read-onlyIdempotent

List FortiGate interfaces with addresses, VLAN tags, and link state, hiding generated internal ones unless included. Filter by IP, type, or VDOM.

Instructions

List interfaces with their addresses, VLAN tags, and link state.

FortiOS creates bookkeeping interfaces alongside real ones, such as the quarantine interface that accompanies every wireless VAP. Those are hidden by default and named in hidden_internal so the omission is visible.

Which ones count as bookkeeping is decided by the appliance rather than by the name. FortiOS reports whether each interface is offered as a policy endpoint, and anything it offers is shown regardless of what it is called, so this tool cannot hide an interface a policy could name. hidden_internal_basis says whether that lookup succeeded; when it did not, the fallback is the name and the omission is less trustworthy.

Filters narrow the list silently unless you read filtered_out, which names each active filter and how many rows it removed. with_ip_only keeps interfaces carrying an IPv4 address in the configuration, which includes a DHCP interface that has taken a lease, because FortiOS writes the leased address back into the config.

An interface that holds no address reports addressing instead of ip. Use get_routing_table for the runtime view.

Input Schema

TableJSON Schema

Name	Required	Description
`vdom`	No	Virtual domain to read. Defaults to the one configured for this target. The `vdom` field in the response names the one actually read.
`limit`	No	Maximum interfaces to return. Defaults to 200, capped at 1000.
`offset`	No	Index to start from, for paging through a large table.
`target`	No	Which FortiGate to query. Optional when only one is configured.
`with_ip_only`	No	Keep only interfaces carrying an IPv4 address in the configuration.
`interface_type`	No	Exact FortiOS type filter, such as physical, vlan, aggregate, hard-switch, switch, or tunnel. Not a substring match.
`include_internal`	No	Include FortiOS-generated interfaces, meaning those the appliance does not offer as policy endpoints and whose names carry a generated prefix such as wqtn., vap., ssl., or naf.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Sep 12, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations cover only the safety profile (readOnly/idempotent/destructive/openWorld); the description adds substantial behavioral context: bookkeeping interfaces hidden by default, the appliance-driven rather than name-driven hiding rule, the hidden_internal_basis fallback and when the omission is less trustworthy, and silent filtering disclosed via filtered_out. This is far beyond what the structured fields convey.

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?

Purpose is front-loaded in the first sentence and every paragraph carries distinct information. It is dense and longer than typical, with several sentences devoted to output-field semantics rather than the call itself, but little is truly redundant.

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 seven-parameter listing tool with an output schema and rich annotations, this is complete: it covers identity, scoping, hidden-by-default behavior, filter transparency, the address-field quirk, and the sibling alternative. An agent could call this correctly without reading anything else.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds genuine meaning the schema lacks: it clarifies that with_ip_only counts a DHCP interface holding a leased address, and explains why interfaces without an address report `addressing` instead of `ip`. It does not touch limit/offset/interface_type, which the schema already covers well.

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?

Opens with a specific verb and resource ('List interfaces') and immediately names what is returned: addresses, VLAN tags, link state. It also distinguishes itself from get_routing_table by scoping itself to configuration rather than the runtime view.

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

Usage Guidelines4/5

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

Explicitly routes the agent to get_routing_table for the runtime view and explains when include_internal and with_ip_only are relevant. It stops short of a full 'use this vs. list_vlans' disambiguation, but the runtime/configuration split is a clear contextual guide.

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

Deploy Server