Skip to main content
Glama

node

Manage GNS3 lab devices by listing, creating, deleting, and configuring them; use wildcard or bulk patterns to control state and apply properties safely.

Instructions

Manage GNS3 nodes (CRUD operations)

v0.47.0: CRUD-style consolidation of create_node, delete_node, and set_node. v0.40.0: Enhanced with wildcard and bulk operation support.

Actions: - list: List nodes in a project - create: Create new node from template at specified coordinates - delete: Delete node(s) from project (WARNING: destructive, cannot be undone) - set: Configure node properties and/or control state (supports wildcards/bulk)

Wildcard Patterns (for 'set' and 'delete'): - Single node: "Router1" - All nodes: "" - Prefix match: "Router" (matches Router1, Router2, RouterCore) - Suffix match: "*-Core" (matches Router-Core, Switch-Core) - Character class: "R[123]" (matches R1, R2, R3) - JSON array: '["Router1", "Router2", "Switch1"]'

Delete safety: - A pattern delete without confirm=True deletes nothing and returns 'matched_nodes' (dry run); repeat with confirm=True to delete them - A single name or a JSON array of names deletes at once - Several nodes return a BatchOperationResult; names not in the project are skipped

Validation Rules: - name parameter requires node to be stopped - Hardware properties (ram, cpus, adapters, hd*_disk_image, cdrom_image, options) apply to both 'create' and 'set'; disk/cdrom/options are QEMU-only - Disk slots: hda = boot disk, hdb = 2nd, hdc = 3rd (via properties), hdd = 4th - Values GNS3 did not apply are reported ('unapplied_properties' / warning) - never silent - For IOU nodes, 'adapters' maps to 'ethernet_adapters' automatically - ports parameter applies to ethernet_switch nodes only - state_action values: start, stop, suspend, reload, restart

Returns: Single node: Status message Multiple nodes: BatchOperationResult JSON with per-node success/failure

Examples: # List nodes in project >>> node(action="list", project_id="abc-123") >>> node(action="list", project_id="abc-123", format="json")

# Create new node
>>> node(action="create", template_name="Alpine Linux", x=100, y=200)
>>> node(action="create", template_name="Cisco IOSv", x=300, y=400, node_name="R1", properties={"ram": 1024})
>>> node(action="create", template_name="Ubuntu Cloud Guest", x=0, y=0, node_name="ops1",
...      ram=12288, cpus=6, adapters=2, hda_disk_image="ops1.qcow2", cdrom_image="seed.iso")

# Delete nodes
>>> node(action="delete", node_name="Router1")
>>> node(action="delete", node_name='["R1", "R2"]')
>>> node(action="delete", node_name="*")                  # lists matches only
>>> node(action="delete", node_name="*", confirm=True)    # deletes every node

# Start all nodes
>>> node(action="set", node_name="*", state_action="start")

# Stop all routers
>>> node(action="set", node_name="Router*", state_action="stop")

# Configure node properties
>>> node(action="set", node_name="R1", x=100, y=200, ram=2048)
>>> node(action="set", node_name="ops1", hda_disk_image="ops1-60G.qcow2", options="-cpu host")

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "action": "<action>"
    },
    "name": "node"
  }
}

Input Schema

NameRequiredDescriptionDefault
xNoX coordinate (top-left corner of node icon)
yNoY coordinate (top-left corner of node icon)
zNoZ-order layer for overlapping nodes
ramNoRAM in MB (QEMU nodes only)
cpusNoNumber of CPUs (QEMU nodes only)
nameNoNew name (REQUIRES node stopped)
portsNoNumber of ports (ethernet_switch nodes only)
actionYesAction: 'list' (list nodes), 'create' (new node), 'delete' (remove node), or 'set' (configure/control node)
formatNoOutput format: 'table' (default) or 'json' (for 'list' action)table
lockedNoLock position to prevent GUI moves
confirmNo'delete' with a wildcard pattern: True deletes every match; False (default) only lists the matches
optionsNoExtra QEMU command-line options, e.g. '-cpu host'
adaptersNoNetwork adapters (QEMU: adapters, IOU: ethernet_adapters)
parallelNoExecute operations concurrently (default: True for start/stop/suspend)
node_nameNoNode name, wildcard pattern ('*', 'Router*', 'R[123]'), or JSON array ('["R1","R2"]'). Required for 'delete' and 'set'
compute_idNoCompute server ID (for 'create')local
project_idNoProject ID (required for 'list')
propertiesNoRaw GNS3 node properties for 'create' and 'set' (e.g. {'ram': 4096, 'hdc_disk_image': 'x.qcow2', 'adapter_type': 'virtio-net-pci'}). Keys GNS3 does not apply are reported back
cdrom_imageNoCD-ROM ISO image, e.g. cloud-init seed (QEMU only)
console_typeNoConsole type: telnet/vnc/spice
state_actionNoState control action for 'set': 'start' (boot), 'stop' (shutdown), 'suspend' (pause), 'reload' (reboot), 'restart' (stop then start)
template_nameNoTemplate name (required for 'create', e.g., 'Alpine Linux', 'Cisco IOSv')
hda_disk_imageNoPrimary (boot) disk image, QEMU 'hda' slot (QEMU only)
hdb_disk_imageNoSecond disk image, QEMU 'hdb' slot (QEMU only)
hdd_disk_imageNoFOURTH disk image, QEMU 'hdd' slot - not the boot disk (QEMU only)

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.60.0
    • addedInput schema / properties / confirm
      Added value: +{
      +  "default": false,
      +  "description": "'delete' with a wildcard pattern: True deletes every match; False (default) only lists the matches",
      +  "type": "boolean"
      +}
  2. Changed6 schema fields changedv0.56.5
    • addedInput schema / properties / cdrom_image
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "CD-ROM ISO image, e.g. cloud-init seed (QEMU only)"
      +}
    • addedInput schema / properties / hda_disk_image
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Primary (boot) disk image, QEMU 'hda' slot (QEMU only)"
      +}
    • addedInput schema / properties / hdb_disk_image
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Second disk image, QEMU 'hdb' slot (QEMU only)"
      +}
    • changedInput schema / properties / hdd_disk_image / description
      Previous value: -"HDD disk image path (QEMU nodes only)"New value: +"FOURTH disk image, QEMU 'hdd' slot - not the boot disk (QEMU only)"
    • addedInput schema / properties / options
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Extra QEMU command-line options, e.g. '-cpu host'"
      +}
    • changedInput schema / properties / properties / description
      Previous value: -"Override template properties for 'create' (e.g., {'ram': 512})"New value: +"Raw GNS3 node properties for 'create' and 'set' (e.g. {'ram': 4096, 'hdc_disk_image': 'x.qcow2', 'adapter_type': 'virtio-net-pci'}). Keys GNS3 does not apply are reported back"
  3. First observedv0.54.2

TDQS

A4.5/5.0
Behavior5/5

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

No annotations are supplied, so the description carries the full behavioral burden. It discloses destructive delete behavior and dry-run confirm safety, batch return semantics, validation rules, unapplied-property reporting, QEMU-only restrictions, and state actions, which is strong disclosure.

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 description front-loads purpose and actions and uses headings and examples appropriate for a 25-parameter multiplexed tool. Version history lines and some repeated warnings are less essential, so it is not maximally concise.

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?

Given the tool's complexity, 25 parameters, and the presence of an output schema, the description covers action scope, safety, validation, return behavior, and examples thoroughly. An agent has enough information to invoke the actions correctly.

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 100%, but the description adds meaningful semantics beyond the schema: wildcard patterns, confirm dry-run behavior, cross-parameter validation, IOU adapter mapping, disk slot meanings, and action-specific requirements. This materially improves correct invocation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States 'Manage GNS3 nodes (CRUD operations)' and enumerates list/create/delete/set with specific resources, so an agent can identify it as the node management tool. It does not explicitly contrast with sibling tools such as project or link, so it stops short of a 5.

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?

The action list and examples clearly explain when to use list, create, delete, and set, including wildcard/bulk behavior and state actions. It lacks explicit guidance on choosing this tool over sibling tools, but internal action selection is well covered.

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