Bunnyshell MCP Server

Bunnyshell MCP 服务

一种通过 Bunnyshell CLI 与 Bunnyshell 平台交互的模型上下文协议（MCP）服务实现。

概述

本项目创建了一个 MCP 服务，使 AI 助手（如 Claude）能够使用 Bunnyshell CLI（bns）与 Bunnyshell 平台交互。该服务提供了一组工具，可通过自然语言命令管理 Bunnyshell 资源。

功能

• 组织管理：列出组织并在其中导航
• 项目管理：创建、列出和删除项目
• 环境管理：创建、列出、启动、停止和删除环境
• 组件操作：部署、调试组件并通过 SSH 连接到组件
• 变量和密钥管理：管理环境变量和密钥
• 远程开发：启动远程开发会话并设置端口转发

前置条件

• Node.js 18+ 和 npm
• 已安装并配置 Bunnyshell CLI（bns）
• Claude Desktop
• Docker 和 Docker Compose（用于 Docker 设置）

安装

本地设置

1. 克隆仓库：

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

2. 运行设置脚本：

./setup.sh

Docker 设置

1. 克隆仓库：

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

2. 运行 Docker 设置脚本：

./docker-setup.sh

使用方法

1. 启动或重启 Claude Desktop
2. 与 Claude 开始新的对话
3. 点击“+”添加附件，然后选择“连接到 MCP 服务”
4. 从服务列表中选择“bunnyshell-mcp”
5. 设置 Bunnyshell API 令牌：

token: YOUR_API_TOKEN

示例命令

你可以向 Claude 提出以下请求：

• “列出我的组织”
• “在组织 ABC123 中创建名为‘MyProject’的新项目”
• “列出项目 XYZ789 中的所有环境”
• “启动环境 ENV123”
• “部署组件 COMP456”
• “在环境 ENV123 中创建名为‘DATABASE_URL’的变量”

开发

项目结构

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

Cursor MCP 配置

.cursor/mcp.json 文件包含 Cursor 中 MCP 服务的配置：

{
  "mcpServers": {
    "bunnyshell-mcp": {
      "command": "node",
      "args": ["dist/index.js"],
      "env": {
        "BNS_API_KEY": "YOUR_API_TOKEN_HERE"
      }
    }
  }
}

对于 Docker 设置，请使用：

{
  "mcpServers": {
    "bunnyshell-mcp": {
      "command": "docker",
      "args": ["exec", "-i", "bns-mcp-server", "node", "dist/index.js"],
      "env": {
        "BNS_API_KEY": "YOUR_API_TOKEN_HERE"
      }
    }
  }
}

**注意：**将 Bunnyshell API 令牌添加到 env 部分后，MCP 服务会自动使用该令牌进行身份验证，无需你在每条命令中提供。代码已会检查 BNS_API_KEY 环境变量。这对开发和个人使用尤其有帮助。对于共享环境，建议不要将令牌写入配置文件，而是在对话过程中提供。

构建

npm install
npm run build

运行测试

npm test

安全

• API 令牌不会存储在代码或配置文件中
• 可通过以下方式提供令牌：
  • 命令行选项
  • 环境变量（BNS_API_KEY）
  • 会话存储（临时，仅存于内存中）
• 命令日志会省略敏感信息

贡献

1. Fork 仓库
2. 创建功能分支
3. 提交更改
4. 推送到分支
5. 创建 Pull Request

许可证

MIT 许可证