GNS3 NetForge MCP
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@GNS3 NetForge MCPLista los proyectos de GNS3 disponibles y muéstrame la topología actual"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
GNS3 NetForge MCP
Servidor Model Context Protocol (MCP) para automatizar laboratorios de red en GNS3. Permite administrar proyectos, routers, switches, VPCS, máquinas virtuales, enlaces y consolas desde ChatGPT mediante una aplicación MCP personalizada.
Funciones principales
Crear, abrir, cerrar y consultar proyectos de GNS3.
Crear, iniciar, detener y reiniciar nodos.
Crear y eliminar enlaces entre dispositivos.
Ejecutar comandos en consolas Telnet y SSH.
Automatizar routers, switches, VPCS y máquinas virtuales.
Consultar topologías, enlaces, sesiones y reportes.
Ejecutar operaciones por lotes y trabajar con Docker.
Usar autenticación por API Key en modo HTTP.
Related MCP server: GNS3 Network Simulator MCP Server
Arquitectura
Cliente MCP → GNS3 NetForge MCP → API de GNS3 → Routers, switches, VPCS y máquinas virtualesPara consultar el flujo completo de creación de laboratorios, revisa lab_setup_workflow.svg.
Requisitos
Windows 10/11, Linux o macOS.
Python 3.10 o superior.
GNS3 Server instalado, encendido y accesible.
Una cuenta de ChatGPT con acceso al modo de desarrollador y aplicaciones MCP personalizadas.
Un endpoint HTTP/HTTPS accesible por ChatGPT.
Preparar el servidor para ChatGPT
Instala las dependencias:
pip install -e .Inicia el servidor MCP en modo HTTP. Cambia los valores por los datos de tu servidor GNS3:
gns3-mcp --transport http --http-host 0.0.0.0 --http-port 8000Comprueba el servicio:
curl http://localhost:8000/healthInstalación desde el código fuente
git clone https://github.com/Arminfx7/gns3-netforge-mcp.git
cd gns3-netforge-mcp
python -m venv .venv
.\\.venv\\Scripts\\Activate.ps1
python -m pip install --upgrade pip
pip install -e .Después inicia el servidor en modo HTTP con el comando indicado en la sección anterior.
Variables de configuración
Puedes usar un archivo .env basado en la plantilla:
Copy-Item .env.example .env
notepad .envVariable | Obligatoria | Ejemplo | Descripción |
GNS3_HOST | Sí | 192.168.1.20 | IP o nombre del servidor GNS3 |
GNS3_PORT | No | 80 | Puerto de la API de GNS3 |
GNS3_USER | Sí | admin | Usuario de GNS3 |
GNS3_PASSWORD | Sí | tu-contrasena | Contraseña de GNS3 |
GNS3_USE_HTTPS | No | false | Activa HTTPS |
GNS3_VERIFY_SSL | No | true | Verifica el certificado SSL |
LOG_LEVEL | No | INFO | Nivel de registro |
Nunca publiques un archivo .env ni contraseñas reales.
Configuración en ChatGPT
ChatGPT utiliza servidores MCP remotos. Si el servidor está en tu computadora o en una red privada, debes publicarlo mediante HTTPS o utilizar un túnel MCP seguro; ChatGPT no se conecta directamente a un servidor local sin ese mecanismo.
En ChatGPT web:
Abre Configuración y entra a Aplicaciones o Aplicaciones conectadas.
Activa Modo de desarrollador si tu plan y espacio de trabajo lo permiten.
Selecciona Crear aplicación o Crear conector MCP personalizado.
Escribe un nombre, por ejemplo GNS3 NetForge MCP.
Introduce la URL HTTPS de tu servidor MCP, por ejemplo
https://tu-dominio.example/mcp.Selecciona el método de autenticación que hayas configurado.
Pulsa Scan Tools, verifica las herramientas y selecciona Create.
Abre un chat nuevo, selecciona la aplicación MCP desde el menú de herramientas y prueba una solicitud como: “Muestra los proyectos disponibles en GNS3”.
La guía oficial se encuentra en Modo de desarrollador y aplicaciones MCP en ChatGPT.
Variables para el servidor HTTP
$env:GNS3_HOST="192.168.1.20"
$env:GNS3_PORT="80"
$env:GNS3_USER="admin"
$env:GNS3_PASSWORD="tu-contrasena"
gns3-mcp --transport http --http-host 0.0.0.0 --http-port 8000No publiques directamente el puerto sin protección. Usa HTTPS, autenticación y un túnel seguro cuando el servidor se encuentre en una red privada.
Uso desde ChatGPT
Después de agregar la aplicación MCP, puedes pedirle a ChatGPT:
“Lista los proyectos de GNS3 disponibles”.
“Muestra la topología del proyecto actual”.
“Inicia los routers R1 y R2”.
“Conecta estos dos dispositivos y verifica el enlace”.
“Abre la consola de R1 y ejecuta show ip interface brief”.
Para acciones que cambien la topología o ejecuten comandos, revisa la confirmación que muestre ChatGPT antes de aceptarla.
Configuración para otros clientes MCP
{
"mcpServers": {
"gns3-mcp": {
"command": "uvx",
"args": ["gns3-mcp@latest"],
"env": {
"GNS3_HOST": "192.168.1.20",
"GNS3_PORT": "80",
"GNS3_USER": "admin",
"GNS3_PASSWORD": "tu-contrasena"
}
}
}
}Reinicia el cliente MCP después de guardar el archivo.
Modo HTTP
$env:GNS3_HOST="192.168.1.20"
$env:GNS3_PORT="80"
$env:GNS3_USER="admin"
$env:GNS3_PASSWORD="tu-contrasena"
gns3-mcp --transport http --host 0.0.0.0 --port 8000Comprueba el servicio:
curl http://localhost:8000/healthDocker
Requisitos: Docker Desktop y acceso de red al servidor GNS3.
Copy-Item .env.example .env
docker compose up -d
docker compose logs -fPara detener los contenedores:
docker compose downDesarrollo y pruebas
pip install -e ".[dev]"
python -m pytest
ruff check .Solución de problemas
Si no conecta con GNS3:
Confirma que GNS3 Server esté encendido.
Comprueba la IP, el puerto y las credenciales.
Verifica el firewall.
Prueba la API:
curl http://192.168.1.20:80/v3/versionSi ChatGPT no muestra la aplicación MCP:
1. Verifica que el endpoint HTTPS sea accesible desde Internet o desde el túnel MCP seguro.
2. Ejecuta nuevamente **Scan Tools** en la configuración de la aplicación.
3. Comprueba que el servidor responda en `/health`.
4. Revisa la autenticación y los permisos de las herramientas.Para problemas con Docker:
docker compose ps
docker compose logs gns3-mcp
docker compose restartDocumentación adicional
DEPLOYMENT.md: despliegue y proxy SSH.
PORTABLE_SETUP.md: instalación portable en Windows.
PUBLISHING.md: publicación y versiones.
docs/architecture: diagramas y arquitectura.
skill/SKILL.md: instrucciones para agentes compatibles.
Créditos y procedencia
Este repositorio es una copia/adaptación de GNS3 MCP Server. El código base fue extraído de:
Autor original: Sergei Chistokhin.
Protocolo utilizado: Model Context Protocol.
Se conserva la licencia MIT y los avisos de copyright del proyecto original. Las modificaciones y la publicación de esta copia corresponden a Arminfx7/gns3-netforge-mcp.
Licencia
Este proyecto se distribuye bajo la licencia MIT. Consulta LICENSE.
Available Tools
15 toolsconsoleA
Execute console operations (BATCH-ONLY)
v0.47.0: Batch-only console tool. Individual console tools removed (aggressive consolidation).
IMPORTANT: Prefer SSH tools when available! Console tools are primarily for:
Initial device configuration (enabling SSH, creating users)
Troubleshooting when SSH is unavailable
Devices without SSH support (VPCS, simple switches)
Two-phase execution:
VALIDATE ALL operations (check nodes exist, required params present)
EXECUTE ALL operations (only if all valid, sequential execution)
Each operation supports all parameters from the underlying console tool:
"send": Send data to console { "type": "send", "node_name": "R1", "data": "show version\n", "raw": false // optional }
"send_and_wait": Send command and wait for pattern { "type": "send_and_wait", "node_name": "R1", "command": "show ip interface brief\n", // optional (v0.49.0: omit for wait-only mode) "wait_pattern": "Router#", // optional "timeout": 30, // optional "raw": false, // optional "handle_pagination": true, // optional (v0.53.4: auto-handle --More--) "pagination_patterns": ["--More--", "---(more)---"], // optional (custom patterns) "pagination_key": " " // optional (default: space, can use "\n" for enter) } Wait-only mode (v0.49.0): Omit "command" to just wait for pattern without sending anything. Useful for monitoring boot sequences or waiting for specific output to appear.
"read": Read console output (NOTE: returns empty if nothing sent yet - this is normal) { "type": "read", "node_name": "R1", "mode": "diff", // optional: diff/last_page/num_pages/all "pages": 1, // optional, only with mode="num_pages" "pattern": "error", // optional grep pattern "case_insensitive": true, // optional "invert": false, // optional "before": 0, // optional context lines "after": 0, // optional context lines "context": 0 // optional context lines (overrides before/after) } IMPORTANT: Console buffer may be empty on first read (QEMU nodes don't output until prompted). Use 'send_and_wait' to explicitly send a command and read the response, or send commands first with 'send'.
"keystroke": Send special keystroke { "type": "keystroke", "node_name": "R1", "key": "enter" // up/down/enter/ctrl_c/etc }
Args: operations: List of operation dictionaries (see examples above)
Returns: JSON with execution results: { "completed": [0, 1, 2], // Indices of successful operations "failed": [3], // Indices of failed operations "results": [ { "operation_index": 0, "success": true, "operation_type": "send_and_wait", "node_name": "R1", "result": {...} // Operation-specific result }, ... ], "total_operations": 4, "execution_time": 5.3 }
Examples: # Multiple commands on one node: >>> console(operations=[ ... {"type": "send_and_wait", "node_name": "R1", "command": "show version\n", "wait_pattern": "Router#"}, ... {"type": "send_and_wait", "node_name": "R1", "command": "show ip route\n", "wait_pattern": "Router#"}, ... {"type": "read", "node_name": "R1", "mode": "diff"} ... ])
# Same command on multiple nodes:
>>> console(operations=[
... {"type": "send_and_wait", "node_name": "R1", "command": "show ip int brief\n", "wait_pattern": "#"},
... {"type": "send_and_wait", "node_name": "R2", "command": "show ip int brief\n", "wait_pattern": "#"},
... {"type": "send_and_wait", "node_name": "R3", "command": "show ip int brief\n", "wait_pattern": "#"}
... ])
# Mixed operations:
>>> console(operations=[
... {"type": "send", "node_name": "R1", "data": "\n"}, # Wake console
... {"type": "read", "node_name": "R1", "mode": "last_page"}, # Check prompt
... {"type": "send_and_wait", "node_name": "R1", "command": "show version\n", "wait_pattern": "#"},
... {"type": "keystroke", "node_name": "R1", "key": "ctrl_c"} # Cancel if needed
... ])| Name | Required | Description | Default |
|---|---|---|---|
| operations | Yes | List of console operations (send/send_and_wait/read/keystroke) |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden and excels. It explains batch-only behavior, two-phase execution, sequential processing, and caveats like empty buffer on first read for QEMU nodes. Version-specific features (v0.47.0 consolidation, v0.49.0 wait-only, v0.53.4 pagination) are disclosed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but well-structured with clear sections: summary, use cases, execution phases, operation types (with sub-bullets), args, returns, and examples. It is front-loaded with the key guidance about SSH preference. Slightly verbose but justified given the complexity of operation types.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is highly complete given the tool's complexity (multiple operation types, batch execution, output schema). It covers the return format with a detailed JSON example, includes multiple comprehensive examples, and addresses edge cases like empty reads and wait-only mode. The output schema is provided in the description.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% but the schema only describes 'operations' as a list of objects. The description adds immense value by fully documenting each operation type (send, send_and_wait, read, keystroke) with complete parameter details, defaults, version notes, and usage tips (e.g., wait-only mode, pagination handling).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool executes console operations as a batch-only interface, specifying the verb 'execute' and resource 'console operations'. It distinguishes from siblings by explicitly recommending SSH tools for general use and listing specific scenarios for console tools (initial config, troubleshooting, unsupported devices).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use and when-not-to-use guidance: 'Prefer SSH tools when available' and lists primary use cases. It also details the two-phase execution process (validate all, then execute), giving clear operational guidelines.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
drawingA
Manage drawings (CRUD operations)
v0.47.0: CRUD-style consolidation of create_drawing, update_drawing, delete_drawing, and create_drawings_batch.
Actions: - list: List all drawings in a project - create: Create new drawing (rectangle, ellipse, line, text) - update: Update existing drawing properties - delete: Delete drawing (WARNING: destructive, cannot be undone) - batch: Create multiple drawings with two-phase validation
Returns: JSON with drawing info or batch operation results
Examples: # List drawings >>> drawing(action="list", project_id="abc-123") >>> drawing(action="list", project_id="abc-123", format="json")
# Create rectangle
>>> drawing(action="create", drawing_type="rectangle", x=100, y=100, width=200, height=100)
# Create text label
>>> drawing(action="create", drawing_type="text", x=175, y=140, text="Router1", z=1)
# Update drawing position
>>> drawing(action="update", drawing_id="abc123", x=200, y=200)
# Delete drawing
>>> drawing(action="delete", drawing_id="abc123")
# Create multiple drawings
>>> drawing(action="batch", drawings=[
... {"drawing_type": "rectangle", "x": 100, "y": 100, "width": 200, "height": 100},
... {"drawing_type": "text", "x": 175, "y": 140, "text": "Router1", "z": 1}
... ])| Name | Required | Description | Default |
|---|---|---|---|
| x | No | X coordinate (start point for line, top-left for others) | |
| y | No | Y coordinate (start point for line, top-left for others) | |
| z | No | Z-order/layer (default: 0 for shapes, 1 for text) | |
| rx | No | Horizontal corner radius (rectangle only) | |
| ry | No | Vertical corner radius (rectangle only) | |
| x2 | No | End X coordinate (line only) | |
| y2 | No | End Y coordinate (line only) | |
| svg | No | SVG content (for 'update') | |
| text | No | Text content (text only) | |
| color | No | Text color hex code (text only) | #000000 |
| width | No | Width in pixels (rectangle/ellipse only) | |
| action | Yes | Action: 'list' (list drawings), 'create' (new drawing), 'update' (modify), 'delete' (remove), or 'batch' (create multiple) | |
| format | No | Output format: 'table' (default) or 'json' (for 'list') | table |
| height | No | Height in pixels (rectangle/ellipse only) | |
| locked | No | Lock/unlock drawing (for 'update') | |
| drawings | No | List of drawing definitions (required for 'batch') | |
| rotation | No | Rotation angle in degrees (for 'update') | |
| font_size | No | Font size in points (text only) | |
| drawing_id | No | Drawing ID (required for 'update' and 'delete') | |
| fill_color | No | Fill color hex code | #ffffff |
| project_id | No | Project ID (required for 'list') | |
| font_family | No | Font family name (text only) | TypeWriter |
| font_weight | No | Font weight: 'normal' or 'bold' (text only) | normal |
| border_color | No | Border color hex code | #000000 |
| border_width | No | Border width in pixels | |
| drawing_type | No | Shape type for 'create': 'rectangle' (box), 'ellipse' (circle/oval), 'line' (connector), 'text' (label) |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Warns about the destructive nature of delete and mentions two-phase validation for batch. With empty annotations, the description carries the full burden and adequately discloses key behaviors, though permissions and side effects are omitted.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with a summary, actions list, return info, and examples. Front-loaded with purpose and no unnecessary text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 26 parameters and 5 actions, the description covers all actions with examples and mentions return format. Output schema exists for detailed returns, so this is adequate. Could be more explicit about required parameters per action, but schema handles that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema already has 100% coverage with descriptions. The description adds value through examples that demonstrate parameter combinations and usage patterns, which is beneficial for understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Manage drawings (CRUD operations)' and lists specific actions (list, create, update, delete, batch). This distinguishes the tool from unrelated siblings and covers all operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit actions and examples for when to use each action, making the usage context clear. However, it does not explicitly state when not to use or alternatives, though no competing tools exist.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
export_topology_diagramA
Export topology diagram to SVG/PNG files on disk. For agents: use diagrams://{project_id}/topology resource for direct access without saving files.
| Name | Required | Description | Default |
|---|---|---|---|
| crop_x | No | ||
| crop_y | No | ||
| format | No | both | |
| crop_width | No | ||
| crop_height | No | ||
| output_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations are empty, so description must disclose behaviors. It states exports to SVG/PNG but omits details like file overwrite behavior, directory creation, authentication needs, or side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loads purpose, provides alternative usage in second sentence. No extraneous words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 6 parameters (most undocumented), no annotations, and output schema present but not described, the description is insufficient for complete understanding of cropping behavior and edge cases.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%. Description adds meaning for format (SVG/PNG) but does not explain crop parameters or output_path requirements beyond existence.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states verb 'Export', resource 'topology diagram', target formats 'SVG/PNG', and destination 'files on disk'. Distinguishes from using diagrams:// resource for direct access.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly suggests using diagrams:// resource when direct access is sufficient, indicating when not to use this tool. No mention of alternative sibling tools like 'drawing'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
gns3_connectionA
Manage GNS3 server connection
CRUD-style connection management tool.
Actions: - check: Check connection status (connection state, error details, last attempt time) - retry: Force immediate re-authentication (bypasses exponential backoff) - reconnect: Full reconnect - re-authenticate AND clear all console/SSH/notification sessions. Use after GNS3 server restart, project switch, or when sessions are stale.
Args: action: Connection action to perform
Returns: JSON with connection status or reconnection result
Examples: # Check connection status >>> gns3_connection(action="check") {"connected": false, "server": "http://192.168.1.20:80", "error": "Connection timeout", "last_attempt": "08:15:42 30.10.2025"}
# Force re-authentication only
>>> gns3_connection(action="retry")
# Full reconnect (clears all sessions)
>>> gns3_connection(action="reconnect")
{"success": true, "sessions_cleared": {"console": 3, "notification": true}}| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Action: 'check' (status), 'retry' (re-auth only), 'reconnect' (re-auth + clear all console/SSH/notification sessions) |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It discloses all behaviors: check returns connection status with error details, retry forces re-auth and bypasses exponential backoff, reconnect clears all sessions. Return values are exemplified, providing full transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections for actions, args, returns, and examples. Every sentence adds value, no fluff. It is concise yet comprehensive, front-loading the purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple tool with one parameter and an output schema, the description covers all necessary aspects: action descriptions, return format, usage examples. It leaves no ambiguity for agent invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with one parameter. The description adds significant meaning beyond the schema: it explains what each action does (e.g., 'bypasses exponential backoff' for retry, 'clear all sessions' for reconnect) which helps the agent select the right action. Slight deduction for not adding new parameter details beyond actions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it manages GNS3 server connection with three specific actions (check, retry, reconnect). It distinguishes itself from sibling tools (ssh, notification, project, etc.) by focusing on connection management.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly explains when to use each action: check for status, retry for re-auth bypassing backoff, reconnect after server restart or project switch. It provides clear context and differentiates between the three actions, guiding the agent to choose correctly.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
http_clientA
HTTP/HTTPS client for lab device web interfaces (CRUD-style)
v0.3.0: HTTP client integration for accessing device APIs and web UIs
Reverse HTTP/HTTPS proxy available at http://proxy:8023/http-proxy/:/ for external device web UI access without SSH tunnel.
Actions: - get: Send HTTP GET request to device and return response - status: Check if device web interface is reachable (HEAD request)
SSL Certificate Handling: - verify_ssl=False (default): Ignore self-signed certificates - verify_ssl=True: Verify SSL certificates (may fail for lab devices)
Reverse Proxy Alternative: Instead of using this tool, you can also access device web UIs through the reverse proxy at http://proxy:8023/http-proxy/:/
Example: http://proxy:8023/http-proxy/10.1.1.1:443/ for HTTPS device
The reverse proxy handles SSL termination and provides persistent access
without needing to make API calls.Returns: JSON response with success status, action, and results
Examples: # Get device web interface >>> http_client(action="get", url="http://10.1.1.1") { "success": true, "action": "get", "status_code": 200, "content": "...", "headers": {"content-type": "text/html", ...} }
# Check device HTTPS API reachability
>>> http_client(action="status", url="https://10.1.1.2:443", verify_ssl=False)
{
"success": true,
"action": "status",
"reachable": true,
"status_code": 200
}
# Get JSON API with custom headers
>>> http_client(
... action="get",
... url="http://10.1.1.3/api/v1/status",
... headers={"Authorization": "Bearer token123", "Accept": "application/json"}
... )
{
"success": true,
"action": "get",
"status_code": 200,
"content": "{\"status\": \"online\", ...}",
"headers": {"content-type": "application/json"}
}
# Alternative: Use reverse proxy (no tool needed)
# Access: http://proxy:8023/http-proxy/10.1.1.1:443/dashboard| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Target URL (http:// or https://) | |
| action | Yes | Action: 'get' (HTTP GET request), 'status' (check reachability) | |
| headers | No | Optional custom HTTP headers | |
| timeout | No | Request timeout in seconds | |
| verify_ssl | No | Verify SSL certificates |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully discloses behavior: read-only actions (get, status), SSL verification options, and the reverse proxy alternative. It also explains return format and shows example responses, ensuring transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections but is somewhat lengthy. It front-loads the purpose and actions, then adds details and examples, making it easy to scan. Could be slightly more concise but still good.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (multiple parameters, two actions, SSL, alternative proxy), the description covers all essential aspects: purpose, actions, SSL handling, alternative, return format, and examples. It is complete and leaves no major gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, but the description adds significant value by explaining action values, SSL details, timeout, and providing extensive examples that illustrate parameter usage and response structure beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it is an HTTP/HTTPS client for lab device web interfaces with CRUD-style actions. It lists specific actions (get, status) and the resource (device web interfaces), distinguishing it from sibling tools like ssh or console.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance on when to use the tool (accessing device APIs/web UIs) and offers an alternative (reverse proxy) for cases where the tool is not needed. It also explains SSL handling and shows example usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
linkA
Manage network connections (links)
v0.47.0: Renamed from set_network_connections to link (CRUD consolidation).
Actions: - list: List all links in a project - batch: Execute multiple connect/disconnect operations with two-phase validation
Two-phase execution for batch operations prevents partial topology changes:
VALIDATE ALL operations (check nodes exist, ports free, adapters valid)
EXECUTE ALL operations (only if all valid - atomic)
Connection Operations (for 'batch' action): Connect: {action: "connect", node_a, node_b, port_a, port_b, adapter_a, adapter_b} Disconnect: {action: "disconnect", link_id}
Examples: # List links >>> link(action="list", project_id="abc-123") >>> link(action="list", project_id="abc-123", format="json")
# Connect two nodes (batch)
>>> link(action="batch", connections=[{
... "action": "connect",
... "node_a": "Router1",
... "node_b": "Router2",
... "port_a": 0,
... "port_b": 0,
... "adapter_a": 0,
... "adapter_b": 0
... }])
# Disconnect link (batch)
>>> link(action="batch", connections=[{"action": "disconnect", "link_id": "abc123"}])Returns: JSON with OperationResult (completed and failed operations) or list of links
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Action: 'list' (list links) or 'batch' (batch operations) | |
| format | No | Output format: 'table' (default) or 'json' (for 'list') | table |
| project_id | No | Project ID (required for 'list') | |
| connections | No | List of connection operations (required for 'batch') |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It details the two-phase validation and atomic execution, the structure of connection operations, and return types. It does not mention potential side effects or permissions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-organized with sections (Actions, Connection Operations, Examples, Returns) but is somewhat verbose, including historical rename info. Most content is earned, but could be slightly more concise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (two actions, batch with validation) and high schema coverage plus output schema, the description covers all necessary aspects: actions, parameters, behavior (atomicity), examples, and return values.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Although schema coverage is 100%, the description adds significant value by showing exact JSON structures for connection operations (e.g., node_a, port_a) and providing examples that clarify parameter usage beyond the schema-defined descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool manages network connections (links) and distinguishes it from siblings by focusing solely on link operations. The historical rename context adds clarity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains the two actions (list and batch) and their use cases, including the atomic two-phase execution for batch. However, it does not explicitly compare to sibling tools like gns3_connection or provide when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
nodeA
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 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"]'
Validation Rules: - name parameter requires node to be stopped - Hardware properties (ram, cpus, hdd_disk_image, adapters) apply to QEMU/IOU/Docker/Dynamips - 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})
# Delete node
>>> node(action="delete", node_name="Router1")
# 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)| Name | Required | Description | Default |
|---|---|---|---|
| x | No | X coordinate (top-left corner of node icon) | |
| y | No | Y coordinate (top-left corner of node icon) | |
| z | No | Z-order layer for overlapping nodes | |
| ram | No | RAM in MB (QEMU nodes only) | |
| cpus | No | Number of CPUs (QEMU nodes only) | |
| name | No | New name (REQUIRES node stopped) | |
| ports | No | Number of ports (ethernet_switch nodes only) | |
| slot1 | No | Dynamips c3600/c3725 network module for slot 1, for example NM-4T | |
| action | Yes | Action: 'list' (list nodes), 'create' (new node), 'delete' (remove node), or 'set' (configure/control node) | |
| format | No | Output format: 'table' (default) or 'json' (for 'list' action) | table |
| locked | No | Lock position to prevent GUI moves | |
| adapters | No | Network adapters (QEMU: adapters, IOU: ethernet_adapters) | |
| parallel | No | Execute operations concurrently (default: True for start/stop/suspend) | |
| node_name | No | Node name, wildcard pattern ('*', 'Router*', 'R[123]'), or JSON array ('["R1","R2"]'). Required for 'delete' and 'set' | |
| compute_id | No | Compute server ID (for 'create') | local |
| project_id | No | Project ID (required for 'list') | |
| properties | No | Override template properties for 'create' (e.g., {'ram': 512}) | |
| adapter_type | No | VirtualBox only: adapter model, for example PCnet-FAST III (Am79C973) | |
| console_type | No | Console type: telnet/vnc/spice | |
| state_action | No | State control action for 'set': 'start' (boot), 'stop' (shutdown), 'suspend' (pause), 'reload' (reboot), 'restart' (stop then start) | |
| template_name | No | Template name (required for 'create', e.g., 'Alpine Linux', 'Cisco IOSv') | |
| hdd_disk_image | No | HDD disk image path (QEMU nodes only) | |
| use_any_adapter | No | VirtualBox only: allow the VM to use any available network adapter |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does substantial work: it flags delete as destructive and irreversible, states that renaming requires a stopped node, documents bulk/wildcard execution and the parallel default, and notes per-node success/failure returns for batch operations. It omits auth/permission requirements and error behavior, keeping it below 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is long but well sectioned (Actions, Wildcards, Validation, Returns, Examples) with the core purpose front-loaded. Some example redundancy (multiple start/stop variants) slightly exceeds what is needed.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 23-parameter multi-action tool this is nearly complete: action semantics, wildcard grammar, validation constraints, and return shapes are all covered. An output schema exists so the Returns section is a bonus, not a necessity, and the remaining gap is error/auth behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3, but the description adds real value beyond the schema: wildcard pattern syntax for node_name, JSON array input form, the IOU 'adapters' → 'ethernet_adapters' mapping, and worked examples of properties overrides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource ('Manage GNS3 nodes') and enumerates the four CRUD actions with one-line semantics each. An agent can distinguish this tool from siblings like link, project, and node_file 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.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Each action is described with its purpose ('delete: Delete node from project'), and the validation/returns sections imply when each action applies. However, there is no explicit guidance on when to prefer this tool over siblings such as node_file or link for node-adjacent operations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
node_fileA
Manage Docker node files (CRUD operations)
v0.47.0: CRUD-style consolidation of get_node_file, write_node_file, and configure_node_network.
Actions: - read: Read file from Docker node filesystem - write: Write file to Docker node filesystem (WARNING: does NOT restart node) - configure_network: Configure network interfaces (full workflow: write + restart)
IMPORTANT: Use 'configure_network' for network configuration as it handles the complete workflow (write config → restart node → apply changes).
Returns: JSON with file contents, confirmation message, or configured interfaces
Examples: # Read file >>> node_file(action="read", node_name="A-PROXY", file_path="etc/network/interfaces")
# Write file
>>> node_file(action="write", node_name="A-PROXY",
... file_path="etc/network/interfaces",
... content="auto eth0\niface eth0 inet dhcp")
# Configure network (recommended)
>>> node_file(action="configure_network", node_name="A-PROXY", interfaces=[{
... "name": "eth0",
... "mode": "static",
... "address": "10.199.0.254",
... "netmask": "255.255.255.0",
... "gateway": "10.199.0.1"
... }])| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Action: 'read' (get file), 'write' (update file), or 'configure_network' (network config workflow) | |
| content | No | File contents (required for 'write') | |
| file_path | No | Path relative to container root (required for 'read' and 'write') | |
| node_name | Yes | Name of the Docker node | |
| interfaces | No | List of interface configs (required for 'configure_network') |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses that 'write' does not restart the node and that 'configure_network' includes restart. It also describes return types (JSON with file contents, confirmation, or configured interfaces). However, it does not detail potential side effects or permissions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with bulleted actions, warnings, and examples. It is concise yet thorough, with every sentence providing necessary information. No redundant text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of a multi-action tool with 5 parameters and no annotations, the description covers all essential aspects: actions, inputs, warnings, return values, and examples. It provides sufficient context for an AI agent to correctly select and invoke the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with all parameters described. The description adds value by providing context (e.g., file_path relative to container root, content required for write, interfaces required for configure_network) and concrete examples, which go beyond the schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool manages Docker node files with CRUD operations and specifies three distinct actions (read, write, configure_network). It distinguishes these actions with clear verbs and resources, and the examples further clarify usage.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly recommends using 'configure_network' for network configuration as it handles the complete workflow, and warns that 'write' does not restart the node. This provides clear guidance on when to use each action, effectively differentiating them.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
notificationA
Subscribe to GNS3 server event notifications and read buffered events.
GNS3 streams real-time events: node state changes, link updates, log messages, etc. This tool subscribes to the stream in background and buffers events for on-demand reading.
Actions: - subscribe: Start listening to notification stream (controller or project-level) - read: Read buffered events (supports diff/all/last modes with optional action filter) - unsubscribe: Stop listening and clear buffer - status: Check subscription status and buffer stats
Event types (action field): Controller: compute., project., template.*, log.error, log.warning, log.info, ping Project: node.created/updated/deleted, link.created/updated/deleted, drawing.created/updated/deleted, snapshot.restored, ping
Examples: # Subscribe to all events >>> notification(action="subscribe")
# Subscribe to specific project events
>>> notification(action="subscribe", project_id="abc-123")
# Read new events since last read
>>> notification(action="read")
# Read only node events
>>> notification(action="read", filter_action="node.")
# Read only log errors
>>> notification(action="read", filter_action="log.error")
# Check status
>>> notification(action="status")| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Read mode: 'diff' (new since last read, default), 'all' (entire buffer), 'last' (last N events) | diff |
| limit | No | Max events to return (default: 100) | |
| action | Yes | Action: 'subscribe' (start listening), 'read' (get events), 'unsubscribe' (stop), 'status' (check subscription) | |
| project_id | No | Project ID for project-level notifications. Omit for controller-level (all events). | |
| filter_action | No | Filter events by action prefix (e.g., 'node.updated', 'log.error', 'link.') |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must fully disclose behavioral traits. It explains that the tool subscribes in the background, buffers events, and supports read modes (diff/all/last). However, it omits details like buffer capacity, behavior on duplicate subscription, or whether subscription persists across calls. This is adequate but leaves some ambiguity.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured: a brief overview, a bullet list of actions, a categorized list of event types, and multiple examples. Every section earns its place, and the most critical information (core actions) is front-loaded. No redundant or vague sentences.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (subscribe/read/unsubscribe/status with filtering) and the presence of an output schema, the description covers all necessary context: actions, parameters, event types, examples, and project vs controller scope. It leaves no obvious gaps for an AI agent to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description adds significant value by explaining each action's purpose, providing the list of event types (e.g., node.created, log.error), and giving concrete examples. This goes beyond the schema property descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Subscribe to GNS3 server event notifications and read buffered events.' It specifies the verb (subscribe/read/unsubscribe/status) and the resource (GNS3 server event notifications). The tool's function is distinct from its siblings (e.g., project, node, link), which focus on direct manipulation rather than event streaming.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context on when to use each action (subscribe, read, unsubscribe, status) with examples. It explains project-level vs controller-level subscription. However, it does not explicitly exclude scenarios or mention when not to use this tool over alternatives (e.g., fetching current state via project/node tools instead of streaming events).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
projectA
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
Args: action: Project action to perform name: Project name (required for open/create) path: Optional project directory path (create only) format: Output format for 'list' action
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")| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Project name (required for 'open' and 'create') | |
| path | No | Optional project directory path (for 'create') | |
| action | Yes | Action: 'list', 'open', 'create', or 'close' | |
| format | No | Output format: 'table' (default) or 'json' (for 'list' action) | table |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It lists actions and their outcomes (e.g., 'auto-open' for create) but does not disclose potential side effects or safety implications (e.g., whether close saves changes). This is adequate but leaves some behavioral aspects implicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections for actions, args, returns, and examples. It is front-loaded with the summary line. Though somewhat lengthy, each part serves a purpose and is not excessively verbose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's CRUD nature and the presence of an output schema mention, the description covers the key functionality. It lacks some behavioral details and does not reference sibling tools, but for a tool with this complexity, it is fairly complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds value beyond the schema by explaining action-specific parameter requirements (e.g., name required for open/create) and providing examples that illustrate parameter usage in context.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it manages GNS3 projects and enumerates specific actions (list, open, create, close), making the tool's purpose specific and unambiguous. It distinguishes itself from siblings by its focus on project-level operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear usage through examples and arg descriptions for each action. However, it does not explicitly mention when not to use this tool or suggest alternatives among siblings, such as project_docs for documentation-related tasks.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
project_docsA
Manage project documentation (CRUD operations)
v0.47.0: CRUD-style consolidation of get_project_readme and update_project_readme.
Actions: - get: Read project README/notes (markdown format) - update: Write project README/notes
Project documentation typically includes: - IP addressing schemes and VLANs - Node credentials (usernames, password vault keys) - Architecture diagrams (text-based) - Configuration templates and snippets - Troubleshooting notes and runbooks
Returns: JSON with project_id and markdown content or success confirmation
Examples: # Get README >>> project_docs(action="get") >>> project_docs(action="get", project_id="a920c77d-6e9b-41b8-9311-b4b866a2fbb0")
# Update README
>>> project_docs(action="update", content="""
... # HA PowerDNS
... ## IPs
... - B-Rec1: 10.2.0.1/24
... - B-Rec2: 10.2.0.2/24
... """)| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Action: 'get' (read README) or 'update' (write README) | |
| content | No | Markdown content (required for 'update') | |
| project_id | No | Project ID (uses current project if not specified) |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description discloses main behaviors: read (get) and write (update) operations, expected input/output format (JSON with project_id and markdown), and includes examples. However, it doesn't specify whether update overwrites or merges content, or authorization requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is concise, well-structured with clear sections: purpose, version, actions, typical content, returns, and examples. Every sentence adds value without repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity, full schema coverage, and presence of output schema, the description covers all necessary aspects: purpose, actions, parameters, typical content, and examples. An agent can correctly invoke the tool based on this description.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the description adds value through examples showing exact usage and format for each parameter, such as markdown content and default project_id behavior.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it manages project documentation with CRUD operations, specifically actions 'get' and 'update'. It distinguishes from sibling tools like 'project' by focusing on documentation content.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides typical use cases and content examples, but does not explicitly compare to alternative tools or state when to avoid using it. The implicit guidance is adequate but not explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
query_resourceC
Universal resource query tool - access any GNS3 MCP resource.
See tool implementation docstring for comprehensive URI pattern documentation.
| Name | Required | Description | Default |
|---|---|---|---|
| uri | Yes | Resource URI to query (see tool description for supported patterns) | |
| format | No | Output format: 'table' (default, human-readable) or 'json' (structured) | table |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavior. It labels itself a 'query tool' implying read-only, but does not explicitly state that it is non-destructive, what the return format is, or any effects. The referral to 'tool implementation docstring' is not part of the description and does not aid transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very short (two sentences) and front-loaded with purpose, which is good. However, the second sentence directs users to external documentation rather than providing the information directly, reducing its immediate value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that no annotations exist and the tool has an output schema, the description should cover behavioral aspects and usage context. It fails to explain when to use this tool, what side effects (if any) occur, or how the output is structured. The presence of an output schema partially compensates, but the lack of usage guidance leaves it incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% for the two parameters. The description adds minimal meaning: 'uri' parameter description merely repeats the advice to see the tool description for patterns, which is not provided. 'format' parameter is adequately described in the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states it is a 'Universal resource query tool' for accessing 'any GNS3 MCP resource', clearly indicating the verb (query) and resource (any GNS3 MCP resource). However, it does not differentiate itself from sibling tools like 'project' or 'node', which also query specific resources.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus its siblings. It simply calls itself 'universal' without specifying that it is intended for generic or unsupported resource access, or when a specific tool is unavailable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_toolsA
Discover GNS3 MCP tools (v0.47.0 - Tool Discovery)
Search and filter available tools by category, capability, or resource URI. Returns tool metadata including description, actions, and applicable resources.
Categories:
project: Project management (open, create, close)
node: Node management (create, delete, configure)
connection: Network connections and GNS3 server
console: Console access to devices
ssh: SSH access to devices
drawing: Topology visualization
resource: Resource query tools
docker: Docker-specific operations
docs: Documentation management
topology: Topology operations
management: Management operations
device-access: Device access (console/SSH)
visualization: Visual elements
discovery: Tool discovery
Capabilities:
CRUD: Supports create/read/update/delete operations via action parameter
batch: Supports batch operations (multiple operations in one call)
wildcard: Supports wildcard patterns (, Router, R[123])
parallel: Supports parallel execution
idempotent: Multiple executions produce same result
Resource Mapping:
projects://: project, list_projects, query_resource
nodes://{project_id}/: node, list_nodes, query_resource
links://{project_id}/: link, query_resource
drawings://{project_id}/: drawing, query_resource
sessions://console/: console, query_resource
sessions://ssh/: ssh, query_resource
topology://{project_id}: get_topology, query_resource
Returns: JSON with matching tools and their metadata
Examples: # Find all CRUD tools >>> search_tools(capability="CRUD")
# Find tools for working with nodes
>>> search_tools(category="node")
# Find tools that work with projects:// resources
>>> search_tools(resource_uri="projects://")
# Find batch operation tools
>>> search_tools(capability="batch")
# Find tools with wildcard support
>>> search_tools(capability="wildcard")| Name | Required | Description | Default |
|---|---|---|---|
| category | No | Filter by category: project, node, console, ssh, drawing, resource, docker, connection, docs, management, device-access, topology, visualization, discovery | |
| capability | No | Filter by capability: CRUD, batch, wildcard, parallel, idempotent | |
| resource_uri | No | Find tools applicable to resource URI (e.g., 'projects://', 'nodes://{project_id}/') |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses that the tool returns tool metadata, lists possible values for categories and capabilities, and provides example calls. It does not explicitly state read-only or non-destructive behavior, but the nature of a search tool implies that. The version number and return format are given, adding transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately long but well-structured with headers, bullet lists, and code examples. Each section (categories, capabilities, resource mapping, examples) adds necessary detail. It is front-loaded with the main purpose and uses markdown formatting for readability. Could be slightly more concise, but overall efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema (context signal: true), the description adequately covers the tool's behavior, input parameters, and return content. It includes categories, capabilities, and resource mappings, making it complete for a discovery tool. The examples illustrate typical usage patterns.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds value by explaining each parameter's purpose with example values and context, such as the list of categories and capabilities. It also shows how to use the resource_uri parameter with concrete URIs. This improves understanding beyond the schema's brief descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it is a tool discovery function for GNS3 MCP tools, explaining that it searches and filters by category, capability, or resource URI. This distinctly sets it apart from sibling tools that manage specific entities (e.g., node, project). The title 'search_tools' and first sentence deliver a specific verb+resource combination.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit categories, capabilities, and resource mappings, along with multiple examples showing how to filter. It does not explicitly state when not to use or alternatives, but the context is clear: use this tool to discover other tools. Given its meta-purpose, the guidance is sufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sshA
Execute SSH operations (BATCH-ONLY)
v0.47.0: Batch-only SSH tool. Individual SSH tools removed (aggressive consolidation). v0.28.0: Local execution support with node_name="@"
Local Execution Support:
Use node_name="@" in any operation for local execution on SSH proxy container
Mix local and remote operations in same batch
Useful for: connectivity tests before device access, ansible playbooks
SSH Proxy Services (v0.3.0):
TFTP Server: Available on port 69/udp at /opt/gns3-ssh-proxy/tftp (use tftp tool)
HTTP/HTTPS Reverse Proxy: Access device web UIs at http://proxy:8023/http-proxy/:/
HTTP Client Tool: Make GET requests to device APIs (use http_client tool)
Two-phase execution prevents partial failures:
VALIDATE ALL operations (check required params, valid types)
EXECUTE ALL operations (only if all valid, sequential execution)
Supported operation types:
"configure": Configure SSH session (equivalent to old ssh_configure)
"command": Execute command (equivalent to old ssh_command, supports local with "@")
"disconnect": Disconnect SSH session
Args: operations: List of operation dicts, each with: - type (str): Operation type (required) - node_name (str): Node name (or "@" for local execution) (required) - Additional params specific to operation type
Returns: JSON with execution results including completed/failed indices
Examples: # Configure session + run commands: >>> ssh(operations=[ ... {"type": "configure", "node_name": "R1", "device_dict": { ... "device_type": "cisco_ios", "host": "10.1.0.1", ... "username": "admin", "password": "cisco123" ... }}, ... {"type": "command", "node_name": "R1", "command": "show version"}, ... {"type": "command", "node_name": "R1", "command": "show ip route"} ... ])
# Same command on multiple nodes:
>>> ssh(operations=[
... {"type": "command", "node_name": "R1", "command": "show ip int brief"},
... {"type": "command", "node_name": "R2", "command": "show ip int brief"}
... ])
# Configuration commands:
>>> ssh(operations=[{
... "type": "command",
... "node_name": "R1",
... "command": [
... "interface GigabitEthernet0/0",
... "ip address 10.1.1.1 255.255.255.0",
... "no shutdown"
... ]
... }])
# Local execution - test connectivity before device access:
>>> ssh(operations=[
... {"type": "command", "node_name": "@", "command": "ping -c 2 10.1.1.1"},
... {"type": "command", "node_name": "@", "command": "ping -c 2 10.1.1.2"},
... {"type": "command", "node_name": "R1", "command": "show ip int brief"},
... {"type": "command", "node_name": "R2", "command": "show ip int brief"}
... ])| Name | Required | Description | Default |
|---|---|---|---|
| operations | Yes | List of SSH operations (command/disconnect) |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses two-phase execution (validate then execute), sequential processing, and batch-only constraint. Lacks explicit safety warnings about destructive commands, but the examples imply configuration changes. No annotations were provided, so description carries full burden.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with sections and enumerated examples, but includes some extraneous details (e.g., TFTP server path) that could be delegated to sibling tool descriptions. Overall effective despite length.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers operation types, two-phase execution, local execution, proxy services, and return format. Given the tool's complexity and presence of an output schema, the description is thorough and leaves no critical gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema only lists operations array with minimal description. The description adds detailed structure for each operation dict (type, node_name, additional params), operation types, and multiple examples, providing comprehensive meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states tool executes SSH operations in batch mode, enumerates operation types (configure, command, disconnect), and distinguishes from siblings like tftp and http_client.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly marks tool as batch-only, explains local execution use cases, and provides examples that mix local and remote operations. Alternatives like tftp and http_client are referenced for non-SSH tasks.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
tftpA
Manage TFTP server files (CRUD-style)
v0.3.0: TFTP server integration for device firmware/config file serving
TFTP server runs on SSH proxy (port 69/udp) with root directory /opt/gns3-ssh-proxy/tftp. Provides read-write access for devices to upload/download files.
Actions: - list: List all files in TFTP root directory - upload: Upload file to TFTP server (requires filename and content) - download: Download file from TFTP server (requires filename) - delete: Delete file from TFTP server (requires filename) - status: Check TFTP server status
File Content Handling: - Upload: Provide raw bytes in content parameter (base64 encoded automatically) - Download: Returns file content as base64 encoded string
Returns: JSON response with success status, action, and results
Examples: # List TFTP files >>> tftp(action="list") { "success": true, "action": "list", "files": [ {"filename": "config.txt", "size": 1024, "modified": "2025-01-15 10:30:00"}, {"filename": "firmware.bin", "size": 5242880, "modified": "2025-01-14 09:15:00"} ] }
# Upload configuration file
>>> tftp(action="upload", filename="startup-config.txt", content=b"hostname Router1\n...")
{"success": true, "action": "upload", "message": "Uploaded startup-config.txt"}
# Download file
>>> tftp(action="download", filename="config.txt")
{"success": true, "action": "download", "content": "aG9zdG5hbWUgUm91dGVyMQo="}
# Delete file
>>> tftp(action="delete", filename="old-config.txt")
{"success": true, "action": "delete", "message": "Deleted old-config.txt"}
# Check TFTP server status
>>> tftp(action="status")
{
"success": true,
"action": "status",
"tftp_enabled": true,
"tftp_port": 69,
"tftp_root": "/opt/gns3-ssh-proxy/tftp",
"file_count": 5,
"total_size": 10485760
}| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Action: 'list' (list files), 'upload' (upload file), 'download' (download file), 'delete' (delete file), 'status' (check TFTP server status) | |
| content | No | File content for upload (raw bytes) | |
| filename | No | Filename for upload/download/delete operations |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses the server runs on port 69/udp, root directory /opt/gns3-ssh-proxy/tftp, read-write access, base64 handling for content, and JSON responses. This is sufficient for safe invocation, though file size limits are not mentioned.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (version, details, actions, handling, examples). While slightly verbose with multiple examples, the information is organized and front-loaded with the primary purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema and complete input schema, the description covers all actions and parameters. Examples illustrate expected responses. No critical gaps are apparent for typical usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% coverage, but the description adds value by explaining each action's parameter requirements, providing examples, and clarifying that upload content should be raw bytes (with automatic base64 encoding). This enhances understanding beyond the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Manage TFTP server files (CRUD-style)' and enumerates five specific actions (list, upload, download, delete, status). This distinguishes it from sibling tools like ssh or node, which perform unrelated functions.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives, or when not to use it. While implied by its name, explicit usage guidance is absent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
15 tool updates
v0.54.2- First observed
console - First observed
drawing - First observed
export_topology_diagram - First observed
gns3_connection - First observed
http_client - First observed
link - First observed
node - First observed
node_file - First observed
notification - First observed
project - First observed
project_docs - First observed
query_resource - First observed
search_tools - First observed
ssh - First observed
tftp
TDQS
Scored across 15 tools
Most tools map to distinct resources (project, node, link, drawing, project_docs) or distinct access methods (ssh, console, http_client), and the ssh/console split is explicitly explained. The main overlap is query_resource, a 'universal' tool whose read purpose duplicates the list actions of project/node/link/drawing, which could cause misselection.
All names use snake_case, and the CRUD-style tools consistently use bare resource nouns (project, node, link, drawing, tftp). A few deviation tools use verb phrases (query_resource, export_topology_diagram, search_tools), but the convention remains readable and predictable.
15 tools is well-scoped for a full GNS3 lab-management server, and each tool covers a meaningful, non-redundant slice (topology CRUD, device access, file transfer, docs, discovery). Nothing feels padded or missing at the count level.
The surface is broad: project/node/link/drawing CRUD, console+SSH device access, file and TFTP management, docs, notifications, topology export, and tool discovery. Minor gaps exist — no snapshot management (only referenced via events), no template CRUD, and no project delete — but core workflows are covered.
Maintenance
Related MCP Connectors
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with yo…
MCP connector that lets ChatGPT list, search, and run your Apple Shortcuts via a local Mac agent
Use your Mac, Windows or Linux computer from ChatGPT, Claude or Codex: files, commands, documents.
Enable secure connectivity between Sentry issues and debugging data, and LLM clients, using a Model Context Protocol (MCP) server.
Related MCP Servers
- FlicenseAqualityDmaintenanceA Model Context Protocol server that enables LLMs to manage network topologies, labs, nodes, and configurations in the EVE-NG network emulation platform through a standardized interface.2615-
- AlicenseBqualityDmaintenanceEnables AI-powered network engineering by providing natural language control over GNS3 network simulations. Supports creating projects, building network topologies, managing devices, controlling simulations, and analyzing network traffic through conversational AI interactions.4225MIT
- AlicenseAqualityDmaintenanceEnables control of GNS3 network lab automation, including projects, nodes, consoles, and SSH, through Claude Desktop or any MCP-compatible client.1584 PyPI15MIT
- AlicenseCqualityCmaintenanceEnables AI agents to control GNS3 network emulation labs. Supports building topologies, managing devices, capturing packets, and automating device CLIs.100MIT