Update README tool descriptions: .txt → .md

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 committed 2026-06-07 23:32:26 +08:00
1 parent 4ca1a80adb
commit f91d7b18e9
2 files changed
+6 -6

No files matched your search

+3 -3
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 (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})
@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 (Markdown format)")],
content: Annotated[str, Field(description="Content to write to README.md (Markdown format)")],
) -> 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})
+3 -3
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, Markdown format)",
"description": "Get the content of a project's README.md 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, Markdown format)",
"description": "Update or create a project's README.md 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 (Markdown format)"},
"content": {"type": "string", "description": "Content to write to README.md (Markdown format)"},
},
"required": ["project_id", "content"],
},