Bns MCP Server

🚀 BunnyShell MCP Server

An implementation of the Model Context Protocol (MCP) server for interacting with the Bunnyshell platform via its CLI interface.

🚀 Quick Start

This project creates an MCP server that enables AI assistants (such as Claude) to interact with the Bunnyshell platform through natural language commands. The server provides a set of tools for managing and operating your Bunnyshell resources.

✨ Features

• Organization Management: List and navigate through organizations.
• Project Management: Create, list, and delete projects.
• Environment Management: Create, list, start, stop, and delete environments.
• Component Operations: Deploy, debug, and SSH into components.
• Variable and Secret Management: Manage environment variables and secrets.
• Remote Development: Start remote development sessions and set up port forwarding.

📦 Installation

Prerequisites

• Node.js 18+ and npm
• Installed and configured Bunnyshell CLI (bns)
• Claude Desktop
• Docker and Docker Compose (for Docker setup)

Local Setup

1. Clone the repository:

git clone https://github.com/bunnyshell/bns-mcp.git
cd bns-mcp

2. Run the setup script:

./setup.sh

Docker Setup

1. Clone the repository:

git clone https://github.com/bunnyshell/bns-mcp.git
cd bns-mcp

2. Run the Docker setup script:

./docker-setup.sh

💻 Usage Examples

Basic Usage

1. Start or restart Claude Desktop.
2. Start a new conversation with Claude.
3. Click '+' to add an attachment and select 'Connect to MCP Server'.
4. Select 'bunnyshell-mcp' from the server list.
5. Set your Bunnyshell API token:

token: Your_API_Token

Advanced Usage

You can ask Claude to perform the following operations:

• "List my organizations"
• "Create a new project named 'MyProject' in organization ABC123"
• "List all environments in project XYZ789"
• "Start environment ENV123"
• "Deploy component COMP456"
• "Create a variable 'DATABASE_URL' in environment ENV123"

📚 Documentation

Project Structure

.
├── src/
│   ├── tools.ts       # Tool implementation
│   ├── utils.ts       # Helper functions
│   └── index.ts       # Server entry point
├── .cursor/
│   └── mcp.json      # Cursor MCP configuration file
├── setup.sh          # Local setup script
├── docker-setup.sh   # Docker setup script
└── README.md         # Documentation

Using Cursor MCP

{
  "version": "1.0",
  "mcpServers": {
    "bunnyshell-mcp": {
      "url": "http://localhost:3000"
    }
  }
}

Contribution Guidelines

If you'd like to contribute, please refer to CONTRIBUTING.md in the project repository.

📄 License

This project is licensed under the MIT License.

Contact

If you have feedback or questions, please contact the project maintainers.