📖 Add restart step and expand tool documentation in README#15
📖 Add restart step and expand tool documentation in README#15clubanderson merged 1 commit intomainfrom
Conversation
Add Step 3 (Restart Claude Code) to installation instructions — plugins require a CLI restart to load the new MCP servers. Also expand tool reference documentation with complete descriptions for all MCP tools. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Andrew Anderson <andy@clubanderson.com>
kubestellar-prow
Bot
added
the
dco-signoff: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome to KubeStellar! 🚀 Thank you for submitting this Pull Request. Before your PR can be merged, please ensure: ✅ DCO Sign-off - All commits must be signed off with ✅ PR Title - Must start with an emoji: ✨ (feature), 🐛 (bug fix), 📖 (docs), 🌱 (infra/tests), Getting Started with KubeStellar: Contributor Resources:
🌟 Help KubeStellar Grow - We Need Adopters! Our roadmap is driven entirely by adopter feedback. Whether you're using KubeStellar yourself or know someone who could benefit from multi-cluster Kubernetes: 📋 Take our Multi-Cluster Survey - Share your use cases and help shape our direction! A maintainer will review your PR soon. Feel free to ask questions in the comments or on Slack! |
|
🎉 Thank you for your contribution! Your PR has been successfully merged. 🌟 Help KubeStellar Grow - We Need Adopters! Our roadmap is driven entirely by adopter feedback - nothing else. Whether you're using KubeStellar yourself or know organizations that could benefit from multi-cluster Kubernetes, we need your help: 📋 Take our Multi-Cluster Survey - Share your use cases and help shape our direction! 🗣️ Spread the word - Tell colleagues, write blog posts, present at meetups 💬 Share feedback on Slack #kubestellar-dev Every adopter story helps us prioritize what matters most. Thank you for being part of the KubeStellar community! |
kubestellar-prow
Bot
added
the
size/XL
There was a problem hiding this comment.
Pull request overview
Updates the top-level README to clarify plugin installation behavior (restart required to load new MCP servers) and significantly expand the MCP tool documentation for both KubeStellar plugins.
Changes:
- Add Step 3: Restart Claude Code after plugin install/update and renumber verification to Step 4.
- Replace the brief MCP tool lists with expanded per-tool reference documentation (parameters, types, requiredness) for both plugins.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <details> | ||
| <summary><strong>GitOps</strong> (1 tool)</summary> | ||
|
|
||
| ##### `detect_drift` | ||
| Detect configuration drift between Git repository manifests and cluster state. | ||
| | Parameter | Type | Required | Description | | ||
| |-----------|------|----------|-------------| | ||
| | `repo_url` | string | **Yes** | Git repository URL (e.g., `https://github.com/org/manifests`) | | ||
| | `path` | string | No | Path within repository to YAML manifests (e.g., `production/`) | | ||
| | `branch` | string | No | Git branch to use (default: `main`) | | ||
| | `cluster` | string | No | Target cluster (uses current context if not specified) | | ||
| | `namespace` | string | No | Override namespace for all resources | | ||
|
|
||
| </details> | ||
|
|
There was a problem hiding this comment.
The kubestellar-ops section documents a GitOps tool (detect_drift) that doesn’t appear anywhere in the kubestellar-ops plugin’s own docs/skills (e.g., plugins/kubestellar-ops/README.md lists no GitOps tools). This makes the top-level README inconsistent with the plugin, and detect_drift is already documented under kubestellar-deploy (with different parameter names). Suggest either removing this GitOps block from kubestellar-ops (or moving it to kubestellar-deploy only), or updating the plugin docs/tool list so both places agree on availability and parameter naming (repo vs repo_url, clusters vs cluster).
| <details> | |
| <summary><strong>GitOps</strong> (1 tool)</summary> | |
| ##### `detect_drift` | |
| Detect configuration drift between Git repository manifests and cluster state. | |
| | Parameter | Type | Required | Description | | |
| |-----------|------|----------|-------------| | |
| | `repo_url` | string | **Yes** | Git repository URL (e.g., `https://github.com/org/manifests`) | | |
| | `path` | string | No | Path within repository to YAML manifests (e.g., `production/`) | | |
| | `branch` | string | No | Git branch to use (default: `main`) | | |
| | `cluster` | string | No | Target cluster (uses current context if not specified) | | |
| | `namespace` | string | No | Override namespace for all resources | | |
| </details> |
Summary
Test plan
🤖 Generated with Claude Code