-
Notifications
You must be signed in to change notification settings - Fork 121
Docs for MCP registry CRD #2027
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: Daniele Martinoli <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2027 +/- ##
==========================================
+ Coverage 48.28% 48.29% +0.01%
==========================================
Files 238 238
Lines 29952 29952
==========================================
+ Hits 14461 14465 +4
+ Misses 14388 14385 -3
+ Partials 1103 1102 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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 comprehensive documentation for the MCPRegistry CRD, which is an experimental feature for managing MCP server registries in Kubernetes. The documentation covers the architecture, usage patterns, and operational aspects of the registry system.
- Introduces complete MCPRegistry documentation with configuration examples and operational guidance
- Updates existing operator documentation to reference the new registry capabilities
- Provides architectural context and development patterns for the registry feature
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
cmd/thv-operator/REGISTRY.md | Complete MCPRegistry reference documentation covering API, configuration, and troubleshooting |
cmd/thv-operator/README.md | Updated operator overview to include MCPRegistry features and installation options |
cmd/thv-operator/DESIGN.md | Added architectural decisions and design patterns specific to MCPRegistry |
cmd/thv-operator/CLAUDE.md | Developer documentation for MCPRegistry development patterns and testing |
README.md | Updated main README to highlight Kubernetes operator capabilities |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
**E2E Tests (🔄 Missing for MCPRegistry)**: | ||
- Chainsaw framework ready but no MCPRegistry tests yet | ||
- MCPServer E2E tests exist as reference |
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.
[nitpick] The status indicates MCPRegistry E2E tests are missing, but this appears to be documenting current state rather than identifying a problem that needs fixing in this PR.
Copilot uses AI. Check for mistakes.
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.
👍 Anyway, I need to update this PR after the recent changes due to E2E tests
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Signed-off-by: Daniele Martinoli <[email protected]>
Note: CI failures will be solved once we merge the e2e test PR which has important changes also tracked in the docs. |
Addresses the docs part of #1749