Troubleshoot MCP Server

🚀 Kubernetes Support Bundle MCP Server

The MCP (Model Context Protocol) Server is a tool designed to manage support bundles within a Kubernetes environment. It offers a wide range of functions, including bundle management, file operations, and the execution of kubectl commands.

🚀 Quick Start

📦 Installation

# Clone the repository
git clone https://github.com/your-username/mcp-server-troubleshoot.git
cd mcp-server-troubleshoot

# Create a virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

🚀 Running the Server

# Start the server
python src/mcp_server_troubleshoot/__main__.py

✨ Features

• Bundle Management: Supports the creation, update, and deletion of support bundles.
• File Operations: Provides read and write capabilities for bundle contents.
• Kubectl Command Execution: Allows direct execution of kubectl commands on the server.

📚 Documentation

• README.md: Project overview.
• docs/: Detailed documentation, including component design and example prompts.
• scripts/: Build and run scripts.

🛠️ Tools

• bundle.py: Bundle management module.
• files.py: File operation module.
• kubectl.py: Kubectl command execution module.

💻 Usage Examples

📝 Basic Usage

from mcp_server_troubleshoot import kubectl

# Execute a Kubectl command
result = kubectl.execute("get pods")
print(result)

📁 Project Structure

.
├── README.md                # Project overview
├── docs/                   # Documentation
│   ├── agentic/            # AI agent documentation
│   ├── components/         # Component design documentation
│   └── examples/           # Example prompts and use cases
└── src/                    # Source code
    └── mcp_server_troubleshoot/
        ├── __init__.py
        ├── __main__.py     # Entry point
        ├── bundle.py       # Bundle management
        ├── cli.py          # CLI interface
        ├── config.py       # Configuration management
        ├── files.py        # File operations
        ├── kubectl.py      # Kubectl command execution
        └── server.py       # MCP server implementation

👨‍💻 Development

📦 Development Installation

# Clone the repository
git clone https://github.com/your-username/mcp-server-troubleshoot.git
cd mcp-server-troubleshoot

# Create a virtual environment
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

🎨 Code Style

# Format code using Black
black .

# Check code style using Ruff
ruff check .

🧪 Testing

# Run all tests
pytest

# Run tests with verbose output
pytest -v

# Run specific types of tests
pytest -m unit
pytest -m integration
pytest -m e2e

# Run tests with all warnings shown
pytest -W all

# Run tests with warnings treated as errors
pytest -W error

📋 Requirements

• Python 3.13
• kubectl command-line tool
• sbctl command-line tool for bundle management
• Authentication token (environment variables: SBCTL_TOKEN or REPLICATED)

All dependencies are included in the Podman container, which is the recommended deployment method.

👥 Contributing

Contributions are welcome! Please refer to the Developer Guide for details on how to contribute.

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.