Skip to content

add readOnlyHint annotation for query #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
king-11 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −7
Open

add readOnlyHint annotation for query #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ def requires_approval(func, params):
def _register_tools(self):
"""Register read-only tools (always available)"""

@self.mcp.tool(tags=["read", "server"])
@self.mcp.tool(tags=["read", "server"], annotations={"readOnlyHint": True})
async def query_server(
action: Annotated[Literal["server_info", "current_user"], Field(
description="Get server info or current user information"
Expand All @@ -123,7 +123,7 @@ async def query_server(
self.process_tool_logs("query_server", result, ctx)
return result

@self.mcp.tool(tags=["read", "workspaces"], enabled="workspaces" in self.toolsets)
@self.mcp.tool(tags=["read", "workspaces"], enabled="workspaces" in self.toolsets, annotations={"readOnlyHint": True})
async def query_workspaces(
action: Annotated[Literal["list", "get", "type", "status"], Field(
description="Workspace query action"
Expand Down Expand Up @@ -157,7 +157,7 @@ async def query_workspaces(
self.process_tool_logs("query_workspaces", result, ctx)
return result

@self.mcp.tool(tags=["read", "files"], enabled="files" in self.toolsets)
@self.mcp.tool(tags=["read", "files"], enabled="files" in self.toolsets, annotations={"readOnlyHint": True})
async def query_files(
action: Annotated[Literal["content", "history", "info", "metadata", "diff", "annotations"], Field(
description="File query action, metadata includes extra information like optional attributes and file size"
Expand Down Expand Up @@ -195,7 +195,7 @@ async def query_files(
self.process_tool_logs("query_files", result, ctx)
return result

@self.mcp.tool(tags=["read", "changelists"], enabled="changelists" in self.toolsets)
@self.mcp.tool(tags=["read", "changelists"], enabled="changelists" in self.toolsets, annotations={"readOnlyHint": True})
async def query_changelists(
action: Annotated[Literal["get", "list"], Field(
description="Changelist query action"
Expand Down Expand Up @@ -246,7 +246,7 @@ async def query_changelists(
self.process_tool_logs("query_changelists", result, ctx)
return result

@self.mcp.tool(tags=["read", "shelves"], enabled="shelves" in self.toolsets)
@self.mcp.tool(tags=["read", "shelves"], enabled="shelves" in self.toolsets, annotations={"readOnlyHint": True})
async def query_shelves(
action: Annotated[Literal["list", "diff", "files"], Field(
description="Shelve query action"
Expand Down Expand Up @@ -280,7 +280,7 @@ async def query_shelves(
self.process_tool_logs("query_shelves", result, ctx)
return result

@self.mcp.tool(tags=["read", "jobs"], enabled="jobs" in self.toolsets)
@self.mcp.tool(tags=["read", "jobs"], enabled="jobs" in self.toolsets, annotations={"readOnlyHint": True})
async def query_jobs(
action: Annotated[Literal["list_jobs", "get_job"], Field(
description="Job query action"
Expand Down Expand Up @@ -314,7 +314,7 @@ async def query_jobs(
self.process_tool_logs("query_jobs", result, ctx)
return result

@self.mcp.tool(tags=["read", "reviews"], enabled="reviews" in self.toolsets)
@self.mcp.tool(tags=["read", "reviews"], enabled="reviews" in self.toolsets, annotations={"readOnlyHint": True})
async def query_reviews(
action: Annotated[Literal["list", "dashboard", "get", "transitions", "files_readby", "files", "comments", "activity"], Field(
description="Review query action: list all reviews, dashboard for current user, get specific review, transitions, files_readby, files, comments, activity"
Expand Down