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
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Project name, exact (required for 'open', 'create' and 'delete') | |
| path | No | Optional project directory path (for 'create') | |
| action | Yes | Action: 'list', 'open', 'create', 'close', or 'delete' | |
| format | No | Output format: 'table' (default) or 'json' (for 'list' action) | table |
| confirm | No | 'delete': True deletes the project; False (default) only describes what would be deleted |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |