NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-10-27 18:52:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix device_command_run KeyError('commands'): tool desc said show_commands but backend expects commands

Browse Source 
- Tool description and param schema now use 'commands' (matching ExecuteMultipleDeviceCommands)
- Updated error message in handler
- Clarified in docstring that this is read-only; use device_config_send for config changes
This commit is contained in:
YueGuobin 2026-06-16 12:23:15 +08:00
parent ec58bea24b
commit e627481ec2
No known key found for this signature in database
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
gns3server/api/routes/mcp/__init__.py
View File

@ -1388,17 +1388,18 @@ async def device_config_send(
async def device_command_run( async def device_command_run(
project_id: Annotated[str, Field(description="UUID of the project")], project_id: Annotated[str, Field(description="UUID of the project")],
device_configs: Annotated[list, Field( device_configs: Annotated[list, Field(
description="List of device commands. Each entry: {\"device_name\": \"R1\", \"show_commands\": [\"show ip int brief\", \"show running-config\"]}" description="List of device commands. Each entry: {\"device_name\": \"R1\", \"commands\": [\"show ip int brief\", \"show running-config\"]}"
)], )],
template: Annotated[str | None, Field(description="Optional Jinja2 template. Use with vars per device. Example: \"show ip route {{ protocol }}\"")] = None, template: Annotated[str | None, Field(description="Optional Jinja2 template. Use with vars per device. Example: \"show ip route {{ protocol }}\"")] = None,
) -> list[dict[str, Any]]: ) -> list[dict[str, Any]]:
"""Run read-only diagnostic (show) commands on network devices via console. """Run read-only diagnostic (show) commands on network devices via console.
Two modes: Two modes:
1. Direct commands: each device has show_commands=[...] 1. Direct commands: each device has commands=[...] (read-only show/display/ping/traceroute only)
2. Jinja2 template: provide template + vars per device 2. Jinja2 template: provide template + vars per device
Use this to inspect device status, view configurations, or verify changes. Use this to inspect device status, view configurations, or verify changes.
For configuration changes use device_config_send instead.
Devices must be started first. Devices must be started first.
""" """
params = {"project_id": project_id, "device_configs": device_configs} params = {"project_id": project_id, "device_configs": device_configs}

2
gns3server/api/routes/mcp/device_config.py
View File

@ -108,7 +108,7 @@ def device_command_run_handler(params: dict[str, Any], gns3_ctx: dict[str, Any])
device_configs = params.get("device_configs") device_configs = params.get("device_configs")
template = params.get("template") template = params.get("template")
if not project_id or not device_configs: if not project_id or not device_configs:
return [{"error": "project_id and device_configs (list of {device_name, show_commands}) are required"}] return [{"error": "project_id and device_configs (list of {device_name, commands}) are required"}]
if template: if template:
device_configs = _render_template(template, device_configs, commands_field="commands") device_configs = _render_template(template, device_configs, commands_field="commands")