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

Update README tool descriptions: .txt → .md

Browse Source 
Only description strings changed to tell AI the content is Markdown
format (.md). The actual handler still reads/writes README.txt for
Web UI compatibility.
This commit is contained in:
YueGuobin 2026-06-07 23:32:26 +08:00
parent 4ca1a80adb
commit f91d7b18e9
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( async def get_project_readme(
project_id: Annotated[str, Field(description="UUID of the project")], project_id: Annotated[str, Field(description="UUID of the project")],
) -> list[dict[str, Any]]: ) -> list[dict[str, Any]]:
"""Get the content of a project's README.txt file — the project documentation (Markdown format).""" """Get the content of a project's README.md file — the project documentation (Markdown format)."""
return await asyncio.to_thread(_run_handler_sync, get_project_readme_handler, {"project_id": project_id}) return await asyncio.to_thread(_run_handler_sync, get_project_readme_handler, {"project_id": project_id})
@mcp.tool() @mcp.tool()
async def update_project_readme( async def update_project_readme(
project_id: Annotated[str, Field(description="UUID of the project")], project_id: Annotated[str, Field(description="UUID of the project")],
content: Annotated[str, Field(description="Content to write to README.txt (Markdown format)")], content: Annotated[str, Field(description="Content to write to README.md (Markdown format)")],
) -> list[dict[str, Any]]: ) -> list[dict[str, Any]]:
"""Update or create a project's README.txt file — the project documentation (Markdown format).""" """Update or create a project's README.md file — the project documentation (Markdown format)."""
return await asyncio.to_thread(_run_handler_sync, update_project_readme_handler, {"project_id": project_id, "content": content}) 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", "name": "get_project_readme",
"description": "Get the content of a project's README.txt file (project documentation, Markdown format)", "description": "Get the content of a project's README.md file (project documentation, Markdown format)",
"parameters": { "parameters": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -291,12 +291,12 @@ PROJECT_TOOLS = [
}, },
{ {
"name": "update_project_readme", "name": "update_project_readme",
"description": "Update or create a project's README.txt file (project documentation, Markdown format)", "description": "Update or create a project's README.md file (project documentation, Markdown format)",
"parameters": { "parameters": {
"type": "object", "type": "object",
"properties": { "properties": {
"project_id": {"type": "string", "description": "Project UUID"}, "project_id": {"type": "string", "description": "Project UUID"},
"content": {"type": "string", "description": "Content to write to README.txt (Markdown format)"}, "content": {"type": "string", "description": "Content to write to README.md (Markdown format)"},
}, },
"required": ["project_id", "content"], "required": ["project_id", "content"],
}, },