The copilot and the MCP service maintained two parallel wrapper layers (LangChain BaseTool classes vs @mcp.tool() functions) over the same handlers in gns3_client/api_handlers.py. Descriptions and parameters drifted apart (compute_id and link_type were missing on the copilot side). This makes the MCP registration the single source of truth and removes the duplicated wrappers. tools_v2/mcp_bridge.py adapts the MCP server's tool registration into LangChain tools: names, descriptions and argument schemas come from the MCP tools. The pool is filtered to project-scoped tools (MCP_ALLOWED_TOOLS) because the copilot runs inside one open project — project management, compute/appliance/image administration and server info tools stay out. The bridge carries the copilot's request JWT into the MCP contextvars (username/token_version decoded from the token so ticket-minting tools work) and runs the async MCP functions from the copilot's sync tool node on either thread flavor. Mode toolsets (teaching / lab_automation / troubleshooting_injection) are now composed from adapted MCP tools plus a few copilot-native ones that add value the MCP versions lack: link_create (port-name resolution), wait_seconds, packet_analysis(+skills), and the topology reader. Eight orphaned LangChain wrappers are deleted. The device command tools had the dependency inverted (the MCP handlers instantiated the copilot LangChain classes and round-tripped through JSON strings). The Nornir/Netmiko classes moved verbatim (git mv) into the shared layer as plain runners — DeviceConfigCommandRunner, DeviceShowCommandRunner, VpcsCommandRunner — with _run(json_string) becoming run(params, gns3_ctx). The optional Jinja2 template rendering moved from the MCP handlers into the runners (and into utils/device_configs.render_device_template), so both entry paths get it; the MCP handlers are now pure delegation. This also drops the json.dumps/json.loads detour the MCP path used to take. test_tool_params consistency gate extended: a handler that forwards the whole params dict to a callee is a wildcard (same rationale as the params.items() case) — the per-key check cannot see through delegation.
6.3 KiB
This documentation is organized by AI with reference to actual code. AI can make mistakes — please verify against the source code when in doubt.
Protocol-Oriented Packet Analysis
Overview
GNS3 Copilot provides protocol-oriented packet analysis that allows the AI assistant to diagnose network issues from live GNS3 captures. Protocol definitions (tshark fields, display filters, check rules) are stored as YAML files in the external GNS3-Skills repository and loaded into memory at startup.
The system exposes two LangChain tools: packet_analysis_skills queries protocol definitions, and packet_analysis runs tshark against downloaded pcap files using the LLM-constructed arguments.
Architecture
graph TD
subgraph "GNS3-Skills Repository"
YAML[packet_analysis/*.yaml<br/>40+ protocol files]
end
subgraph "GNS3 Server"
SM[SkillsManager]
SL[SkillsLoader]
REG[PACKET_ANALYSIS_REGISTRY<br/>in-memory dict]
SKILL[packet_analysis_skills<br/>query protocol definitions]
TOOL[packet_analysis<br/>run tshark on captures]
end
subgraph "tshark"
FIELDS["tshark -G fields"<br/>live field registry]
CAP["tshark -r pcap"<br/>packet capture analysis]
end
YAML -->|load at startup / reload| SL
SL --> REG
SM --> SL
SKILL -->|read protocol fields/filters| REG
TOOL -->|validate -e fields| FIELDS
TOOL -->|download pcap + run tshark| CAP
Supported Protocols
Definitions are loaded from GNS3-Skills/packet_analysis/*.yaml. The following protocol families are covered:
| Category | Protocols |
|---|---|
| Network Layer | ip, ipv6, arp, icmp, icmpv6 |
| Transport Layer | tcp, udp |
| Data Link | ethernet, ppp, hdlc, frame_relay, vlan, isl, llc |
| Routing | ospf, eigrp, rip, bgp, isis, pim, dvmrp |
| Link Protocols | l2tp, lacp, pagp, udld |
| Infrastructure | cdp, lldp, stp, vtp, dtp |
| Management | snmp, telnet, ssh, radius, tacacs |
| Application | dns, http, bootp, dhcp |
| Tunneling / Security | gre, esp, ah, mpls, eapol, ssl, isakmp |
| Miscellaneous | nbns, slarp, ocsp, wccp, auto_rp, loop |
Each protocol YAML contains:
name: "OSPF Packet Analysis"
description: "Analyze OSPF routing protocol packets"
protocol_key: "ospf"
display_filter: "ospf"
fields:
- label: "Source IP"
tshark_field: "ip.src"
description: "Source IPv4 address"
- label: "OSPF Message Type"
tshark_field: "ospf.msg"
description: "1=Hello, 2=DBD, 3=LSR, 4=LSU, 5=LSAck"
filter_examples:
- description: "Show OSPF Hello packets"
filter: "ospf.msg == 1"
checks:
- name: hello_dead_mismatch
severity: critical
message: "Hello/Dead Interval mismatch between neighbors"
Analysis Flow
sequenceDiagram
participant LLM as LLM Agent
participant SKILL as packet_analysis_skills
participant TOOL as packet_analysis
participant tshark as tshark
participant GNS3 as GNS3 Server
LLM->>SKILL: {"action": "list"}
SKILL-->>LLM: Available protocols
LLM->>SKILL: {"action": "get", "protocol": "ospf"}
SKILL-->>LLM: Fields, filters, check rules
Note over LLM: LLM constructs tshark_args<br/>using protocol knowledge
LLM->>TOOL: {project_id, link_id,<br/>tshark_args: "-Y ospf -T fields -e ip.src -e ospf.msg"}
TOOL->>TOOL: Validate -e field names<br/>against tshark -G fields
TOOL->>GNS3: Download pcap for link_id
GNS3-->>TOOL: Capture file
TOOL->>tshark: tshark -r pcap -Y ospf -T fields -e ip.src -e ospf.msg
tshark-->>TOOL: Tab-separated output
TOOL-->>LLM: Raw tshark output
Tool Registration
The packet analysis tools are available in two copilot modes:
| Tool | Teaching Assistant | Lab Automation | Troubleshooting Injection |
|---|---|---|---|
packet_analysis |
Yes | Yes | No |
packet_analysis_skills |
Yes | Yes | No |
Tool Interface
packet_analysis_skills
Queries protocol definitions from the PACKET_ANALYSIS_REGISTRY. Used before running tshark to look up valid field names, display filters, and anomaly checks.
| Action | Input | Output |
|---|---|---|
| List protocols | {"action": "list"} |
{count, protocols: [{protocol, name, description}]} |
| Get protocol | {"action": "get", "protocol": "ospf"} |
Protocol definition with fields, filters, checks |
packet_analysis
Runs tshark against a downloaded GNS3 capture file. Supports two modes:
Capture analysis mode:
| Parameter | Required | Description |
|---|---|---|
project_id |
Yes | UUID of the GNS3 project |
link_id |
Yes | UUID of the link to analyze |
tshark_args |
Yes | tshark arguments (after -r <pcap>) |
Field search mode:
| Parameter | Required | Description |
|---|---|---|
action |
Yes | "search_fields" |
query |
Yes | Single keyword (e.g., "ospf.lsa", "bgp.open") |
Validation and Error Handling
Before downloading the capture, the tool validates -e field names against the live tshark field registry (tshark -G fields). Invalid field names are rejected early with a hint to use search_fields.
| Scenario | Response |
|---|---|
Invalid -e field name |
{error, hint, invalid_fields} |
| tshark filter/field error | {error: "tshark argument error", hints} |
| Empty capture file | {error: "Capture file is empty"} |
| No matching packets | {result: "No matching packets found", hints} |
| tshark timeout (30s) | {error: "tshark timeout after 30 seconds"} |
| tshark not installed | {error: "tshark not installed"} |
When -c is used and no results are found, the tool hints that -c limits total packets read (not matched count), and suggests removing it or piping to head.
Hot Reload
Packet analysis protocols can be reloaded without restarting the server via the existing reload API:
POST /v3/copilot/reload/skills
This triggers SkillsManager.reload_packet_analysis_protocols(), which re-reads all YAML files from the packet_analysis/ directory and updates PACKET_ANALYSIS_REGISTRY in place.