Enforce explicit ReadOnlyHint on all MCP tool definitions via AST validation#2487
Draft
Copilot wants to merge 1 commit into
Draft
Enforce explicit ReadOnlyHint on all MCP tool definitions via AST validation#2487Copilot wants to merge 1 commit into
ReadOnlyHint on all MCP tool definitions via AST validation#2487Copilot wants to merge 1 commit into
Conversation
Copilot
AI
changed the title
Add AST CI check for explicit ReadOnlyHint tool annotations
Enforce explicit May 17, 2026
ReadOnlyHint on all MCP tool definitions via AST validation
Copilot created this pull request from a session on behalf of
SamMorrowDrums
May 17, 2026 06:41
View session
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
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.
Summary
Adds a compile-time-style guard in tests to ensure every
mcp.Toolinpkg/githubexplicitly setsAnnotations.ReadOnlyHint. This prevents silent regressions where missing annotations degrade runtime permission behavior.Why
ReadOnlyHintpresence must be explicit and continuously enforced, including for future refactors and feature-flagged tool variants.What changed
TestToolDefinitionsRequireExplicitReadOnlyHintinpkg/github/tools_validation_test.go.pkg/github, inspectsmcp.Tool{...}literals, and fails ifAnnotations.ReadOnlyHintis missing.file:line+tool=<name>+ missing-field reason to make fixes immediate.MCP impact
Validation-only change; no runtime schema/behavior/tool registration changes.
Prompts tested (tool changes only)
Security / limits
Test-only guardrail; no auth/data-path changes.
Tool renaming
deprecated_tool_aliases.goNote: if you're renaming tools, you must add the tool aliases. For more information on how to do so, please refer to the official docs.
Lint & tests
./script/lint./script/testDocs