Skip to content

Conversation

@gossion
Copy link
Member

@gossion gossion commented Dec 1, 2025

This pull request updates the documentation in the README.md file to clarify the usage of unified and legacy tool modes for the mcp-kubernetes server, and to improve explanations around access levels and available tools. The changes make it easier for users to understand how to configure and use the server in both modes, and how operations are filtered by access level.

Tool configuration and usage:

  • Added documentation for the new USE_LEGACY_TOOLS environment variable, which allows switching between unified and legacy tool modes.
  • Introduced a section explaining the difference between the unified call_kubectl tool (default) and the legacy mode with multiple specialized tools, including example configuration for enabling legacy mode.
  • Expanded the "Available Tools" section to detail the unified tool's usage, parameters, and example commands, as well as how legacy tools are provided when legacy mode is enabled.

Access levels and filtering:

  • Clarified the explanation of access levels, focusing on how operations and tools are filtered rather than listing available tools for each level.

Documentation structure:

  • Improved grouping and formatting of additional tools (e.g., Helm) under the legacy tools section for better readability.

Copy link
Contributor

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 pull request updates the README documentation to introduce and explain the new unified kubectl tool mode alongside the legacy multi-tool mode. The changes help users understand the difference between the two modes and how to configure them.

  • Added documentation for the USE_LEGACY_TOOLS environment variable to toggle between unified and legacy tool modes
  • Restructured the "Available Tools" section to clearly distinguish between the default unified call_kubectl tool and optional legacy tools
  • Simplified the "Access Levels" section to focus on operation filtering rather than tool availability

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- **Parameters**:
- `command`: The full kubectl command to execute (e.g., "get pods -n default", "apply -f deployment.yaml")
- **Examples**:
```bash
Copy link

Copilot AI Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code block uses bash syntax highlighting, but the examples show parameter values for a JSON/YAML configuration, not actual bash commands. Consider using a plain text code block or a more appropriate language identifier like yaml or text to avoid confusion.

Suggested change
```bash
```yaml

Copilot uses AI. Check for mistakes.
@Fei-Guo Fei-Guo merged commit 7371bc7 into main Dec 1, 2025
12 checks passed
@Fei-Guo Fei-Guo deleted the guwe/docs branch December 1, 2025 04:44
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.

4 participants