From 4ca1a80adbfc81318f8a7cae97942f511208dec6 Mon Sep 17 00:00:00 2001
From: YueGuobin <yueguobin@outlook.com>
Date: Sun, 7 Jun 2026 23:23:38 +0800
Subject: [PATCH] Update README tool descriptions to mention Markdown format

Web UI supports rendering Markdown in README.txt, so note this in the
tool descriptions and content parameter.
---
 gns3server/api/routes/mcp/__init__.py | 6 +++---
 gns3server/api/routes/mcp/projects.py | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/gns3server/api/routes/mcp/__init__.py b/gns3server/api/routes/mcp/__init__.py
index b4bbd1ce5..a52ff991d 100644
--- a/gns3server/api/routes/mcp/__init__.py
+++ b/gns3server/api/routes/mcp/__init__.py
@@ -304,16 +304,16 @@ async def duplicate_project(
 async def get_project_readme(
     project_id: Annotated[str, Field(description="UUID of the project")],
 ) -> list[dict[str, Any]]:
-    """Get the content of a project's README.txt file — the project documentation."""
+    """Get the content of a project's README.txt file — the project documentation (Markdown format)."""
     return await asyncio.to_thread(_run_handler_sync, get_project_readme_handler, {"project_id": project_id})
 
 
 @mcp.tool()
 async def update_project_readme(
     project_id: Annotated[str, Field(description="UUID of the project")],
-    content: Annotated[str, Field(description="Content to write to README.txt")],
+    content: Annotated[str, Field(description="Content to write to README.txt (Markdown format)")],
 ) -> list[dict[str, Any]]:
-    """Update or create a project's README.txt file — the project documentation."""
+    """Update or create a project's README.txt file — the project documentation (Markdown format)."""
     return await asyncio.to_thread(_run_handler_sync, update_project_readme_handler, {"project_id": project_id, "content": content})
 
 
diff --git a/gns3server/api/routes/mcp/projects.py b/gns3server/api/routes/mcp/projects.py
index d718a0e1d..ebd514d51 100644
--- a/gns3server/api/routes/mcp/projects.py
+++ b/gns3server/api/routes/mcp/projects.py
@@ -279,7 +279,7 @@ PROJECT_TOOLS = [
     },
     {
         "name": "get_project_readme",
-        "description": "Get the content of a project's README.txt file (project documentation)",
+        "description": "Get the content of a project's README.txt file (project documentation, Markdown format)",
         "parameters": {
             "type": "object",
             "properties": {
@@ -291,12 +291,12 @@ PROJECT_TOOLS = [
     },
     {
         "name": "update_project_readme",
-        "description": "Update or create a project's README.txt file (project documentation)",
+        "description": "Update or create a project's README.txt file (project documentation, Markdown format)",
         "parameters": {
             "type": "object",
             "properties": {
                 "project_id": {"type": "string", "description": "Project UUID"},
-                "content": {"type": "string", "description": "Content to write to README.txt"},
+                "content": {"type": "string", "description": "Content to write to README.txt (Markdown format)"},
             },
             "required": ["project_id", "content"],
         },