# RabbitMQ MCP Server

[中文版](./README_CN.md) | English Version

A RabbitMQ maintenance server for Cline, providing RabbitMQ management tools through the MCP (Model Context Protocol).

## 🚀 Installation and Configuration

### 📋 System Requirements

- **Node.js**: 16.0 or higher
- **RabbitMQ Server**: With management plugin enabled

### 📦 Installation Steps

```bash
# Clone the project
git clone https://github.com/sansong089/rabbitmq-mcp-server
cd rabbitmq-mcp-server

# Install dependencies
npm install

# Build the project
npm run build
```

### ⚙️ Configuration

#### Claude Desktop

Add to `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "rabbitmq-mcp-server": {
      "command": "node",
      "args": ["C:\\path\\to\\your\\rabbitmq-mcp-server\\build\\index.js"],
      "env": {
        "RABBITMQ_HOST": "localhost",
        "RABBITMQ_PORT": "15672",
        "RABBITMQ_USER": "guest",
        "RABBITMQ_PASS": "guest",
        "RABBITMQ_VHOST": "/"
      }
    }
  }
}
```

#### Cline

Add in Cline MCP settings:

```json
{
  "mcpServers": {
    "rabbitmq-mcp-server": {
      "command": "node",
      "args": ["/path/to/your/rabbitmq-mcp-server/build/index.js"],
      "env": {
        "RABBITMQ_HOST": "localhost",
        "RABBITMQ_PORT": "15672",
        "RABBITMQ_USER": "guest",
        "RABBITMQ_PASS": "guest",
        "RABBITMQ_VHOST": "/"
      }
    }
  }
}
```

**Note**: Please replace the path with the actual path to the `build/index.js` file after building the project.

### ✅ Verification

After setup, ask the AI assistant to list available tools. You should see RabbitMQ-related tools such as `get_cluster_status`, `list_queues`, `create_queue`, etc.

## 🎯 Use Case

This project is specifically designed for the **Cline + Claude** environment, allowing you to manage RabbitMQ directly in a chat interface without opening a browser or using command line tools.

## 🔧 Development and Build

### Install Dependencies
```bash
npm install
```

### Build Project
```bash
npm run build
```

### Development Mode
```bash
npm run watch
```

### Test Connection
```bash
npm run inspector
```

## 🛠️ Features

### 🏗️ Cluster Management
- `get_cluster_status` - Get cluster status information

### 📋 Queue Management
- `list_queues` - List queues
- `create_queue` - Create queue
- `delete_queue` - Delete queue

### 🔄 Exchange Management
- `list_exchanges` - List exchanges
- `create_exchange` - Create exchange
- `get_exchange` - Get exchange information
- `delete_exchange` - Delete exchange

### 🔗 Binding Management
- `list_bindings` - List bindings
- `create_binding` - Create binding
- `delete_binding` - Delete binding

### 🏠 Virtual Host Management
- `list_vhosts` - List virtual hosts
- `create_vhost` - Create virtual host
- `delete_vhost` - Delete virtual host

### 👥 User Management
- `list_users` - List users
- `create_user` - Create user
- `delete_user` - Delete user

### 🔌 Connection Management
- `list_connections` - List connections

### 📨 Message Operations
- `publish_message` - Publish message
- `consume_message` - Consume message

## ⚙️ Usage in Cline

### Basic Queries (No Approval Required)
- View queues: `list all queues`
- View exchanges: `list all exchanges`
- View users: `list all users`

### ⚠️ Modification Operations (Manual Approval Required)

**Important Reminder:** All modification and deletion operations require your manual confirmation! AI assistants will not automatically execute these operations.

#### Create Operations
- Create queue: `create a queue named test-queue`
- Create user: `create a user named admin`
- Create exchange: `create a direct type exchange`

#### Delete Operations
- Delete queue: `delete the queue named test-queue`
- Delete user: `delete the user named guest`
- Delete exchange: `delete the exchange named test-exchange`

##  Design Philosophy

### Simplicity First, No Permission Restrictions

This project adopts a minimalist design:

- ✅ **No extra permission controls**: All operations are managed through MCP protocol
- ✅ **Simple installation**: No complex configuration, ready to use out of the box
- ✅ **Easy to use**: Manage RabbitMQ directly in chat

This makes RabbitMQ management as natural as chatting!

### Security Considerations

- All modification operations require user manual approval
- Recommended for use in trusted network environments
- Production environments should add additional security measures

## 📋 System Requirements

- **Node.js**: 16.0 or higher
- **RabbitMQ Server**: With management plugin enabled
- **Cline**: MCP protocol support

## ⚠️ Important Disclaimer

**Critical Warning: Modification and deletion operations must NEVER be authorized for automatic execution by AI assistants**

**Please read the following terms carefully:**

1. **Usage Restrictions**
   - This software is for learning, development, and testing purposes only
   - Do not use in unauthorized production environments

2. **Risk Warnings**
   - Users must bear all consequences of operations themselves
   - Including but not limited to data loss, service interruption, etc.

3. **Security Warnings**
   - **Modification and deletion operations must NEVER be authorized for automatic execution by AI assistants**
   - All destructive operations must go through manual confirmation and review
   - Operations with Confluence administrative privileges may cause serious security risks
   - Please run in secure and controllable environments

4. **Disclaimer**
   - This project is provided "as is" without any express or implied warranties
   - The author is not responsible for any damages caused by using this software

**Please ensure you understand and accept the above terms before use.**

---

[中文版](./README_CN.md) | [Back to Top](#rabbitmq-mcp-server)