From 0b2c784b8197a3020498a865f1fdef5ef5d4d7ee Mon Sep 17 00:00:00 2001 From: YueGuobin Date: Thu, 11 Jun 2026 12:13:31 +0800 Subject: [PATCH] docs: Fix appliance_install description - it does NOT download images --- gns3server/api/routes/mcp/__init__.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/gns3server/api/routes/mcp/__init__.py b/gns3server/api/routes/mcp/__init__.py index 3f679a581..cff1ae774 100644 --- a/gns3server/api/routes/mcp/__init__.py +++ b/gns3server/api/routes/mcp/__init__.py @@ -1137,7 +1137,13 @@ async def appliance_get( async def appliance_install( appliance_id: Annotated[str, Field(description="UUID of the appliance to install")], ) -> list[dict[str, Any]]: - """Install (download and set up) an appliance from the template library.""" + """Create a template from a GNS3 appliance definition. + + NOTE: This does NOT download images. Images must be placed in the + GNS3 images directory (e.g. ~/GNS3/images/) beforehand. + The appliance definition is read from local .gns3a files bundled with the server. + Use get_appliance first to see what images are required. + """ return await asyncio.to_thread(_run_handler_sync, install_appliance_handler, { "appliance_id": appliance_id, })