mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
feat: Add device configuration MCP tools (config_send, command_run, vpcs_config_set)
- Add jwt_token/url parameters to get_device_ports_from_topology() and GNS3TopologyTool for MCP handler compatibility (backward compatible, auto-detection fallback) - Add jwt_token/url pass-through to ExecuteMultipleDeviceConfigCommands, ExecuteMultipleDeviceCommands, and VPCSCommands _run() methods - Create MCP handler device_config.py wrapping the 3 device config tools - Register as device_config_send, device_command_run, vpcs_config_set
This commit is contained in:
7 files changed
+215
-9
No files matched your search
@@ -70,6 +70,10 @@ from .images import (
|
||||
delete_image_handler, prune_images_handler,
|
||||
install_images_handler,
|
||||
)
|
||||
from .device_config import (
|
||||
device_config_send_handler, device_command_run_handler,
|
||||
vpcs_config_set_handler,
|
||||
)
|
||||
from .nodes import (
|
||||
get_nodes_handler, get_node_handler, start_node_handler,
|
||||
stop_node_handler, reload_node_handler, suspend_node_handler,
|
||||
@@ -1133,6 +1137,71 @@ async def image_install() -> list[dict[str, Any]]:
|
||||
return await asyncio.to_thread(_run_handler_sync, install_images_handler, {})
|
||||
|
||||
|
||||
# ── Device config tools ───────────────────────────────────────────────
|
||||
# These tools connect to network device consoles via telnet/SSH using
|
||||
# Nornir + Netmiko. Devices must be started and have a device_type tag.
|
||||
#
|
||||
# Workflow:
|
||||
# 1. node_list(project_id) → identify device names
|
||||
# 2. node_start_all(project_id) → ensure devices are running
|
||||
# 3. device_config_send(project_id, device_configs=[...]) → push config
|
||||
# 4. device_command_run(project_id, device_commands=[...]) → verify
|
||||
|
||||
|
||||
@mcp.tool()
|
||||
async def device_config_send(
|
||||
project_id: Annotated[str, Field(description="UUID of the project")],
|
||||
device_configs: Annotated[list, Field(
|
||||
description="List of device configs. Each entry: {\"device_name\": \"R1\", \"config_commands\": [\"int lo0\", \"ip add 1.1.1.1 255.255.255.255\"]}"
|
||||
)],
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Send configuration commands to network devices via console (telnet/SSH).
|
||||
|
||||
Devices must be started first (use node_start or node_start_all).
|
||||
Device type is auto-detected from the 'device_type:<type>' tag on each node.
|
||||
Common device types: cisco_ios_telnet, cisco_xr_telnet, huawei_telnet, gns3_huawei_telnet_ce
|
||||
"""
|
||||
return await asyncio.to_thread(_run_handler_sync, device_config_send_handler, {
|
||||
"project_id": project_id, "device_configs": device_configs,
|
||||
})
|
||||
|
||||
|
||||
@mcp.tool()
|
||||
async def device_command_run(
|
||||
project_id: Annotated[str, Field(description="UUID of the project")],
|
||||
device_commands: Annotated[list, Field(
|
||||
description="List of device show commands. Each entry: {\"device_name\": \"R1\", \"show_commands\": [\"show ip int brief\", \"show running-config\"]}"
|
||||
)],
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Run read-only diagnostic (show) commands on network devices via console.
|
||||
|
||||
Use this to inspect device status, view configurations, or verify changes.
|
||||
Devices must be started first.
|
||||
"""
|
||||
return await asyncio.to_thread(_run_handler_sync, device_command_run_handler, {
|
||||
"project_id": project_id, "device_commands": device_commands,
|
||||
})
|
||||
|
||||
|
||||
@mcp.tool()
|
||||
async def vpcs_config_set(
|
||||
project_id: Annotated[str, Field(description="UUID of the project")],
|
||||
device_configs: Annotated[list, Field(
|
||||
description="List of VPCS configs. Each entry: {\"device_name\": \"PC1\", \"commands\": [\"ip 10.0.0.1/24 10.0.0.254\", \"save\"]}"
|
||||
)],
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Configure VPCS devices (set IP addresses, gateway, etc.).
|
||||
|
||||
VPCS-specific configuration commands:
|
||||
- ip <address>/<mask> <gateway> Set IP and gateway
|
||||
- save Save config to startup.vpc
|
||||
- ping <target> Test connectivity
|
||||
"""
|
||||
return await asyncio.to_thread(_run_handler_sync, vpcs_config_set_handler, {
|
||||
"project_id": project_id, "device_configs": device_configs,
|
||||
})
|
||||
|
||||
|
||||
# ── Auth‑wrapped SSE app ──────────────────────────────────────────────
|
||||
|
||||
def _make_auth_wrapper(inner_app):
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
#
|
||||
# Copyright (C) 2026 GNS3 Technologies Inc.
|
||||
# Author: Yue Guobin
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
"""
|
||||
MCP tool handlers for device configuration via Nornir + Netmiko.
|
||||
|
||||
These tools connect to network device consoles via telnet/SSH and execute
|
||||
configuration or diagnostic commands. Device connection info is automatically
|
||||
discovered from the project topology using the device's tags for device_type.
|
||||
|
||||
Prerequisites:
|
||||
- Device must be started (use node_start / node_start_all)
|
||||
- Device must have a 'device_type:<type>' tag set in GNS3
|
||||
(right-click → Configure → Tags → add 'device_type:cisco_ios_telnet')
|
||||
- Device must have a console port assigned
|
||||
"""
|
||||
|
||||
import json
|
||||
import logging
|
||||
from typing import Any
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# ── Tool handlers ──────────────────────────────────────────────────────────
|
||||
|
||||
def device_config_send_handler(params: dict[str, Any], gns3_ctx: dict[str, Any]) -> list[dict[str, Any]]:
|
||||
"""Send configuration commands to network devices via console."""
|
||||
project_id = params.get("project_id")
|
||||
device_configs = params.get("device_configs")
|
||||
if not project_id or not device_configs:
|
||||
return [{"error": "project_id and device_configs are required"}]
|
||||
|
||||
from gns3server.agent.gns3_copilot.tools_v2.config_tools_nornir import ExecuteMultipleDeviceConfigCommands
|
||||
|
||||
tool = ExecuteMultipleDeviceConfigCommands()
|
||||
input_data = json.dumps({
|
||||
"project_id": project_id,
|
||||
"device_configs": device_configs,
|
||||
})
|
||||
return tool._run(
|
||||
input_data,
|
||||
jwt_token=gns3_ctx["jwt_token"],
|
||||
url=gns3_ctx["server_url"],
|
||||
)
|
||||
|
||||
|
||||
def device_command_run_handler(params: dict[str, Any], gns3_ctx: dict[str, Any]) -> list[dict[str, Any]]:
|
||||
"""Run read-only diagnostic (show) commands on network devices."""
|
||||
project_id = params.get("project_id")
|
||||
device_commands = params.get("device_commands")
|
||||
if not project_id or not device_commands:
|
||||
return [{"error": "project_id and device_commands are required"}]
|
||||
|
||||
from gns3server.agent.gns3_copilot.tools_v2.display_tools_nornir import ExecuteMultipleDeviceCommands
|
||||
|
||||
tool = ExecuteMultipleDeviceCommands()
|
||||
input_data = json.dumps({
|
||||
"project_id": project_id,
|
||||
"device_commands": device_commands,
|
||||
})
|
||||
return tool._run(
|
||||
input_data,
|
||||
jwt_token=gns3_ctx["jwt_token"],
|
||||
url=gns3_ctx["server_url"],
|
||||
)
|
||||
|
||||
|
||||
def vpcs_config_set_handler(params: dict[str, Any], gns3_ctx: dict[str, Any]) -> list[dict[str, Any]]:
|
||||
"""Configure VPCS devices (set IP, gateway, etc.)."""
|
||||
project_id = params.get("project_id")
|
||||
device_configs = params.get("device_configs")
|
||||
if not project_id or not device_configs:
|
||||
return [{"error": "project_id and device_configs are required"}]
|
||||
|
||||
from gns3server.agent.gns3_copilot.tools_v2.vpcs_tools_netmiko import VPCSCommands
|
||||
|
||||
tool = VPCSCommands()
|
||||
input_data = json.dumps({
|
||||
"project_id": project_id,
|
||||
"device_configs": device_configs,
|
||||
})
|
||||
return tool._run(
|
||||
input_data,
|
||||
jwt_token=gns3_ctx["jwt_token"],
|
||||
url=gns3_ctx["server_url"],
|
||||
)
|
||||
Reference in new issue
Block a user