Add policy demo sample for MCP Gateway#824
Open
mugiwaraluffy56 wants to merge 1 commit intoKuadrant:mainfrom
Open
Add policy demo sample for MCP Gateway#824mugiwaraluffy56 wants to merge 1 commit intoKuadrant:mainfrom
mugiwaraluffy56 wants to merge 1 commit intoKuadrant:mainfrom
Conversation
Signed-off-by: puneeth_aditya_5656 <myakampuneeth@gmail.com>
📝 WalkthroughWalkthroughAdds a new policy-demo sample configuration for MCP Gateway, comprising five test MCP server registrations with tool prefixes, three virtual servers exposing specific tool sets, a Keycloak JWT-based AuthPolicy for tool access control, and supporting documentation with usage examples. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@config/samples/policy-demo/authpolicy.yaml`:
- Around line 21-23: The predicate is currently unconditional and can block
non-tool methods; update the predicate used in the policy to first check
request.method == "tools/call" and only then perform the existing
header-and-role validation (i.e., check request.headers['x-mcp-toolname']
against auth.identity.resource_access and the roles list), otherwise allow the
request; modify the predicate expression referenced as predicate (using
request.method, request.headers['x-mcp-toolname'], and
auth.identity.resource_access) so only tools/call is role-checked.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 0a593aca-2450-4af6-be9a-94dfb4183c83
📒 Files selected for processing (5)
config/samples/policy-demo/README.mdconfig/samples/policy-demo/authpolicy.yamlconfig/samples/policy-demo/kustomization.yamlconfig/samples/policy-demo/mcpserverregistrations.yamlconfig/samples/policy-demo/mcpvirtualservers.yaml
Comment on lines
+21
to
+23
| - predicate: | | ||
| request.headers['x-mcp-toolname'] in (has(auth.identity.resource_access) && auth.identity.resource_access.exists(p, p == request.headers['x-mcp-servername']) ? auth.identity.resource_access[request.headers['x-mcp-servername']].roles : []) | ||
| response: |
There was a problem hiding this comment.
Scope authorization to tools/call to avoid blocking non-tool methods.
Current predicate is unconditional; it can deny initialize/tools/list because they don’t carry a usable tool header. Add a method guard so only tools/call is role-checked.
Suggested patch
'tool-access-check':
patternMatching:
patterns:
- predicate: |
- request.headers['x-mcp-toolname'] in (has(auth.identity.resource_access) && auth.identity.resource_access.exists(p, p == request.headers['x-mcp-servername']) ? auth.identity.resource_access[request.headers['x-mcp-servername']].roles : [])
+ request.headers['x-mcp-method'] != 'tools/call' || (
+ request.headers['x-mcp-toolname'] in (
+ has(auth.identity.resource_access) &&
+ auth.identity.resource_access.exists(p, p == request.headers['x-mcp-servername'])
+ ? auth.identity.resource_access[request.headers['x-mcp-servername']].roles
+ : []
+ )
+ )📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - predicate: | | |
| request.headers['x-mcp-toolname'] in (has(auth.identity.resource_access) && auth.identity.resource_access.exists(p, p == request.headers['x-mcp-servername']) ? auth.identity.resource_access[request.headers['x-mcp-servername']].roles : []) | |
| response: | |
| - predicate: | | |
| request.headers['x-mcp-method'] != 'tools/call' || ( | |
| request.headers['x-mcp-toolname'] in ( | |
| has(auth.identity.resource_access) && | |
| auth.identity.resource_access.exists(p, p == request.headers['x-mcp-servername']) | |
| ? auth.identity.resource_access[request.headers['x-mcp-servername']].roles | |
| : [] | |
| ) | |
| ) | |
| response: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@config/samples/policy-demo/authpolicy.yaml` around lines 21 - 23, The
predicate is currently unconditional and can block non-tool methods; update the
predicate used in the policy to first check request.method == "tools/call" and
only then perform the existing header-and-role validation (i.e., check
request.headers['x-mcp-toolname'] against auth.identity.resource_access and the
roles list), otherwise allow the request; modify the predicate expression
referenced as predicate (using request.method,
request.headers['x-mcp-toolname'], and auth.identity.resource_access) so only
tools/call is role-checked.
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.
summary
This adds a policy demo sample under config/samples/policy-demo.
The sample wires together local test MCP servers, MCPServerRegistration resources, virtual server views, and an optional AuthPolicy. It gives contributors a single place to try federation, backend credentials, custom paths, virtual servers, and tool-level authorization with the local environment.
testing
I also checked the optional AuthPolicy manifest by inspection. A client dry-run tried to reach a local Kubernetes API server in this environment, so I did not count that as a manifest validation result.
Summary by CodeRabbit