Skip to main content
Glama
rstierli

FortiManager MCP Server

by rstierli

create_device_sniffer

Creates a persistent firewall sniffer definition on a managed FortiGate device, enabling continuous traffic capture with filters for interface, host, port, protocol, VLAN, IPv6, and non-IP packets.

Instructions

Create a firewall sniffer definition on a managed device.

This targets the FortiGate's own persistent firewall sniffer object (device-DB, Configuration API firewall.json /firewall/sniffer) so the capture actually runs on the device's own traffic -- not FortiManager's separate, unrelated local diagnostic sniffer (/cli/global/system/sniffer, a different object that happens to share a name). Unlike FMG's local sniffer there is no packet-count cap or start/stop action: the definition captures continuously while status is "enable", same as any other persistent FortiOS config object -- disable or delete it to stop.

Args: device: Managed device name interface: Interface name traffic sniffing takes place on host: Hosts to filter for (e.g. "1.1.1.1", "2.2.2.0/24") port: Ports to sniff (e.g. "80", "1-1024") protocol: IANA protocol number as a string (e.g. "6" for TCP) vlan: VLAN(s) to sniff capture_ipv6: Include IPv6 packets (default: False) capture_non_ip: Include non-IP packets (default: False) status: "enable" or "disable" (default: "enable") logtraffic: "all", "utm", or "disable" (optional) sniffer_id: Explicit sniffer ID (0-9999); omit to let FortiOS assign the next available one vdom: VDOM the sniffer lives in (default "root")

Returns: Creation result including the new sniffer id

Input Schema

NameRequiredDescriptionDefault
hostNo
portNo
vdomNoroot
vlanNo
deviceYes
statusNoenable
protocolNo
interfaceYes
logtrafficNo
sniffer_idNo
capture_ipv6No
capture_non_ipNo

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, the description carries the burden well: it discloses that the capture runs continuously while status='enable', that stopping requires disable/delete, and that there is no packet-count cap. It omits operational context an agent would want for a config mutation on FortiManager — whether an ADOM commit (commit_adom) or install is required for the change to take effect, and what happens if sniffer_id collides with an existing entry.

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?

The opening sentence front-loads the action and target, and the Args block is justified given zero schema coverage. The parenthetical path strings and backticked object names are somewhat verbose, but the material is substantive rather than filler.

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

Completeness4/5

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

For a 12-parameter mutation with no annotations, the description covers purpose, object identity, parameter formats, and lifecycle. An output schema exists so return values need not be explained (the extra 'Returns' line is harmless). The remaining hole is deployment semantics — commit/install requirements and ID-collision behavior — which matters for a FortiManager write tool.

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

Parameters5/5

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

Schema coverage is 0%, so the description must compensate, and it does: all 12 parameters are documented inline with formats and examples ('1.1.1.1', '2.2.2.0/24', '80', '1-1024', IANA protocol number as string), defaults for capture_ipv6/capture_non_ip/status/vdom, the 0-9999 range for sniffer_id, and auto-assignment semantics when omitted. This adds substantial meaning beyond the bare JSON schema types.

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 ('Create a firewall sniffer definition on a managed device') and pins down exactly which object is created (device-DB firewall.json /firewall/sniffer). It explicitly disambiguates from the same-named FortiManager local diagnostic sniffer, so the agent knows this is a persistent FortiOS config object, not a local capture.

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?

Gives clear context for choosing this over the FortiManager local sniffer and clarifies the lifecycle difference ('no packet-count cap or start/stop action... disable or delete it to stop'). It does not however route the agent between this and sibling tools like create_device_on_demand_sniffer or start_packet_capture, so the alternative choice is only partially resolved.

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