Skip to main content
Glama

project

Manage GNS3 lab environments by listing, opening, creating, closing, or deleting them; deletion offers a dry run and requires confirmation to prevent accidental removal.

Instructions

Manage GNS3 projects

CRUD-style project management tool.

Actions: - list: List all projects - open: Open a project by name - create: Create a new project and auto-open it - close: Close the currently opened project - delete: Delete a project by exact name with all its nodes, disks and files (WARNING: cannot be undone). Without confirm=True it is a dry run that deletes nothing and returns the project's id, status and path

Args: action: Project action to perform name: Project name (required for open/create/delete) path: Optional project directory path (create only) format: Output format for 'list' action confirm: Required (True) for 'delete' to actually delete

Returns: JSON with ProjectInfo for created project, or list of projects

Examples: # List all projects >>> project(action="list") >>> project(action="list", format="json")

# Open existing project
>>> project(action="open", name="My Lab")

# Create new project
>>> project(action="create", name="Production Lab")
>>> project(action="create", name="Test Lab", path="/opt/gns3/projects")

# Close current project
>>> project(action="close")

# Delete a project (dry run first, then confirm)
>>> project(action="delete", name="Test Lab")
>>> project(action="delete", name="Test Lab", confirm=True)

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": "project"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoProject name, exact (required for 'open', 'create' and 'delete')
pathNoOptional project directory path (for 'create')
actionYesAction: 'list', 'open', 'create', 'close', or 'delete'
formatNoOutput format: 'table' (default) or 'json' (for 'list' action)table
confirmNo'delete': True deletes the project; False (default) only describes what would be deleted

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.60.0
    • changedInput schema / properties / action / description
      Previous value: -"Action: 'list', 'open', 'create', or 'close'"New value: +"Action: 'list', 'open', 'create', 'close', or 'delete'"
    • changedInput schema / properties / action / enum
      Previous value: -[
      -  "list",
      -  "open",
      -  "create",
      -  "close"
      -]New value: +[
      +  "list",
      +  "open",
      +  "create",
      +  "close",
      +  "delete"
      +]
    • addedInput schema / properties / confirm
      Added value: +{
      +  "default": false,
      +  "description": "'delete': True deletes the project; False (default) only describes what would be deleted",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / name / description
      Previous value: -"Project name (required for 'open' and 'create')"New value: +"Project name, exact (required for 'open', 'create' and 'delete')"
  2. First observedv0.54.2

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full behavioral burden and does most of it: it discloses irreversibility ('WARNING: cannot be undone'), the destructive default being a no-op dry run, the cascade scope (nodes, disks and files), and the create side effect of auto-opening. It stops short of error behavior (unknown name, deleting the currently open project) and any permission requirements.

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?

Front-loaded summary, then action list, args, returns and examples — a predictable structure with little wasted text. The only redundancy is the opening 'CRUD-style project management tool' line, which restates 'Manage GNS3 projects' without adding information.

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?

An output schema exists, so the description did not need a Returns section, yet it adds a brief one anyway. For a five-parameter, five-action tool with no annotations, coverage is strong; only failure modes and permission/auth expectations are absent, which are minor for a local project manager.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description goes further by binding parameters to actions — name is required for open/create/delete, path is create-only, format applies only to list, and confirm gates actual deletion. That action-parameter mapping is meaning the schema's per-property text does not state as directly.

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?

The description names the resource (GNS3 projects) and enumerates every action with a specific verb-level meaning: list, open, create (auto-open), close, delete. An agent can tell exactly what the tool does and how each mode differs from the others without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Each action carries its own trigger condition ('open: Open a project by name', 'delete: Delete a project by exact name'), and the delete section prescribes a concrete workflow: dry run first, then re-issue with confirm=True. The examples reinforce the intended sequence rather than leaving the agent to infer it.

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