-
Notifications
You must be signed in to change notification settings - Fork 2
Add K8s client connectivity guide #310
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
Signed-off-by: Dan Barr <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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 adds a comprehensive guide for connecting clients to MCP servers running in Kubernetes, covering both external connectivity via Ingress/Gateway API and internal cluster connectivity. The guide helps users expose MCP servers securely and establish proper connection patterns for different scenarios.
- Adds detailed documentation on connecting external and internal clients to Kubernetes-hosted MCP servers
- Provides practical examples for Ingress, Gateway API, and in-cluster service discovery patterns
- Includes extensive troubleshooting section covering common connectivity issues
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/toolhive/guides-k8s/connect-clients.mdx | New comprehensive guide explaining client connectivity options for MCP servers in Kubernetes, including external access via Ingress/Gateway API and internal cluster access patterns |
| sidebars.ts | Adds the new connect-clients guide to the Kubernetes guides section in the appropriate position between run-mcp-k8s and remote-mcp-proxy |
| docs/toolhive/guides-k8s/intro.mdx | Adds reference to the new connectivity guide explaining how to expose MCP servers and connect clients |
| docs/toolhive/guides-k8s/run-mcp-k8s.mdx | Updates "Next steps" section to reference the new connectivity guide with more detailed context about connection options |
| docs/toolhive/tutorials/k8s-ingress-ngrok.mdx | Adds tip box referencing the new general connectivity guide for broader context beyond the ngrok-specific tutorial |
Co-authored-by: Copilot <[email protected]>
Signed-off-by: Dan Barr <[email protected]>
|
Setting to draft for now while I validate auth interoperability (esp. with rewrites) |
Description
Adds a guide detailing options for connecting clients to MCP servers running in Kubernetes:
Related issues/PRs
Closes #307
Merge checklist
Content
sidebars.ts) updated for added, deleted, reordered, or renamed filesvercel.jsonfor moved, renamed, or deleted pages (i.e., if the URL slug changed)Reviews