Add tool annotations to server-github#3425
Open
Ratnaditya-J wants to merge 1 commit intomodelcontextprotocol:archive-serversfrom
Open
Add tool annotations to server-github#3425Ratnaditya-J wants to merge 1 commit intomodelcontextprotocol:archive-serversfrom
Ratnaditya-J wants to merge 1 commit intomodelcontextprotocol:archive-serversfrom
Conversation
Add readOnlyHint, destructiveHint, idempotentHint, and openWorldHint annotations to all 26 tools in the GitHub MCP server. Read operations (get, list, search) are marked read-only and idempotent. Write operations (create, update, push) are marked non-read-only. merge_pull_request is marked destructive since merges are irreversible. All tools are marked openWorldHint since they interact with GitHub's API. Closes modelcontextprotocol#3399
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds readOnlyHint, destructiveHint, idempotentHint, and openWorldHint annotations to all 26 tools in the GitHub server, as requested in #3399.
Read operations like list_issues, get_pull_request, and search_code are marked read-only and idempotent. Create operations like create_issue and create_pull_request are marked non-destructive since they add new resources without modifying existing ones. merge_pull_request is the only tool marked destructive since merging a PR into a target branch is effectively irreversible without force-push.
All tools are marked openWorldHint: true since every tool on this server makes API calls to api.github.com and can affect state beyond the local environment.
This is a metadata-only change to src/github/index.ts. No behavior changes, just annotation additions. The TypeScript build passes cleanly.
Followed the same annotation pattern used in the filesystem server.