-
Notifications
You must be signed in to change notification settings - Fork 95
docs: add gateways and proxies section to README #438
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.
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
base: main
Are you sure you want to change the base?
Conversation
1a3e488
to
c60ff92
Compare
Also, just an FYI, I'm n on PTO this coming week so won't be able to address any feedback until the end of next week. |
…y practices might be relevant
Hi @nickytonline ! Thanks for opening the PR. I've been reviewing it and so far it looks good. I've added a few changes to clarify that having these examples in the README.md do not:
I'll ask other teammates to review this and if everything looks fine for them too, we'll merge it and close the underlying issue. Thanks a lot for your contribution and enjoy your PTO! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the README documentation by replacing a basic proxy support section with a comprehensive "Gateways and Proxies" section that covers both inbound authentication security and outbound proxy configuration.
- Reorganizes proxy documentation with better structure and security guidance
- Adds detailed information about authentication gateways like Pomerium for securing remote MCP deployments
- Expands proxy configuration examples with environment variables and usage instructions
Comments suppressed due to low confidence (1)
Co-authored-by: Copilot <[email protected]>
Proposed changes
As per you comment in #416 @kmruiz, I've submitted a PR to get the ball rolling. This PR adds a gateways and proxies section to the README docs.
Closes #416
Checklist