NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-09-04 00:55:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README tool descriptions to mention Markdown format

Browse Source 
Web UI supports rendering Markdown in README.txt, so note this in the
tool descriptions and content parameter.
This commit is contained in:
YueGuobin 2026-06-07 23:23:38 +08:00
parent 4921b98948
commit 4ca1a80adb
No known key found for this signature in database
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
gns3server/api/routes/mcp/__init__.py
View File

@ -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})

6
gns3server/api/routes/mcp/projects.py
View File

@ -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"],
},