Skip to content

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nickytonline
Copy link

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

@Copilot Copilot AI review requested due to automatic review settings August 10, 2025 04:31
@nickytonline nickytonline requested a review from a team as a code owner August 10, 2025 04:31
Copilot

This comment was marked as outdated.

@nickytonline
Copy link
Author

nickytonline commented Aug 10, 2025

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.

@kmruiz
Copy link
Collaborator

kmruiz commented Aug 11, 2025

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:

  • Endorse any third party.
  • They are not enough in terms of security best practices and should be reviewed.
  • We provide them in a best-effort basis and we don't do technical support on them (delegated to the actual third-party).

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!

@kmruiz kmruiz requested a review from Copilot August 11, 2025 09:13
Copy link
Contributor

@Copilot Copilot AI left a 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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Concrete Gateway Examples to Security Documentation
2 participants