basicdeploy-mcp

BasicDeploy MCP 服务

Agent 部署到的持久化运行时：通过一次 MCP 调用即可获取数据库、对象存储、Kafka 代理和公开 URL。

一个 MCP（Model Context Protocol） 服务，可让 AI 编码 Agent（Claude Code、Cursor 及任何 MCP 客户端）直接创建和管理 BasicDeploy 容器。每个容器都自动配置 PostgreSQL 数据库、兼容 S3 的对象存储、Kafka 代理、环境变量和公开 HTTPS URL。你的 Agent 可以创建容器、部署应用（自动检测 Node、Python、Go 或 Docker）、运行命令、读取日志、管理 Kafka 主题、查看当前认证身份、启用常驻运行，以及共享或删除容器。

• 🌐 网站：https://basicdeploy.com
• 📦 npm：https://www.npmjs.com/package/basicdeploy-mcp
• 📚 文档：https://basicdeploy.com/docs

快速开始

需要 Node.js ≥ 18。无需安装，npx 会按需获取。

在 https://basicdeploy.com/api-keys 获取 API 密钥（格式类似 bd_…，密钥只会显示一次），然后将以下内容添加到 MCP 客户端：

{
  "mcpServers": {
    "basicdeploy": {
      "command": "npx",
      "args": ["-y", "basicdeploy-mcp@latest"],
      "env": {
        "BASICDEPLOY_API_KEY": "bd_your_api_key",
        "BASICDEPLOY_URL": "https://basicdeploy.com"
      }
    }
  }
}

Claude Code：

claude mcp add basicdeploy \
  --env BASICDEPLOY_API_KEY=bd_your_api_key \
  --env BASICDEPLOY_URL=https://basicdeploy.com \
  -- npx -y basicdeploy-mcp@latest

Claude Code 插件（此仓库同时也是一个插件市场）：

/plugin marketplace add AkaciaNL/basicdeploy-mcp
/plugin install basicdeploy-mcp@basicdeploy

然后在环境中设置 BASICDEPLOY_API_KEY（插件通过 ${BASICDEPLOY_API_KEY} 读取该变量）。

OpenAI Codex CLI：

codex mcp add basicdeploy \
  --env BASICDEPLOY_API_KEY=bd_your_api_key \
  --env BASICDEPLOY_URL=https://basicdeploy.com \
  -- npx -y basicdeploy-mcp@latest

或直接将其添加到 ~/.codex/config.toml：

[mcp_servers.basicdeploy]
command = "npx"
args = ["-y", "basicdeploy-mcp@latest"]
env = { BASICDEPLOY_API_KEY = "bd_your_api_key", BASICDEPLOY_URL = "https://basicdeploy.com" }

环境变量

变量	必填	描述
BASICDEPLOY_API_KEY	是	你的 API 密钥（bd_…）。调用任何工具都需要此密钥（即使没有密钥，服务仍会启动并列出其工具，方便客户端查看）。
BASICDEPLOY_URL	否	API 基础 URL。默认为 https://basicdeploy.com。

工具

工具	参数	描述
list_containers	（无）	列出你的容器：子域名、状态、URL、ID、创建时间。
create_container	memoryMb?（256/512/1024/2048）、alwaysOn?	创建一个容器。系统会自动配置数据库和 S3 存储桶。更大的规格需要 Pro/Scale；Free 方案的持续运行功能需使用付费附加名额。
get_container	containerId	完整详情：URL、状态、端口、数据库名称/用户、S3 存储桶、卷路径。
deploy_app	tarballPath、containerId?	从磁盘部署 .tar/.tar.gz/.tgz/.zip 文件。解压到 /workspace，自动检测运行时，并在 :8080 上启动应用。省略 containerId 可创建新容器；传入该参数可部署到现有容器。
exec_command	containerId、command	在容器内运行 shell 命令；返回输出和退出代码。
get_logs	containerId、tail?（默认值为 200）	获取容器的近期日志。
set_always_on	containerId、enabled	开启/关闭容器的 24/7 持续运行标志。
wake_container	containerId	唤醒休眠的容器，使其恢复处理流量。
sleep_container	containerId	让运行中的容器进入休眠以释放内存（下次收到请求时唤醒）。
get_account	（无）	你的方案、容器上限（方案 + 附加项）、可选内存规格、存储上限和附加项。
share_container	containerId、email、expiresInHours?	通过电子邮件与其他用户共享容器（对方会收到登录链接）。省略 expiresInHours 表示无限期共享。
delete_container	containerId	永久操作：销毁容器、数据库及所有文件。
whoami	（无）	此连接通过哪个账户进行身份验证（电子邮件 + ID）。
get_kafka	（无）	Kafka 连接详情（SASL/SCRAM）：内部和外部引导地址、用户名/密码、消费者组前缀、主题、用量和限额。首次调用时配置。
create_topic	label?	创建 Kafka 主题（自动在你的前缀下命名；可选的易读标签）。如果超出主题/存储预算则失败。
purge_topic	name	清空你拥有的主题（删除其中的消息，但保留主题）。出错后可重新开始处理。
delete_topic	name	永久操作：删除你拥有的主题及其所有消息。

运行时

已部署的应用必须监听 0.0.0.0:8080，这是公共 URL 提供服务的端口。DATABASE_URL、S3_ENDPOINT / S3_ACCESS_KEY / S3_SECRET_KEY / S3_BUCKET 和 KAFKA_BOOTSTRAP / KAFKA_USERNAME / KAFKA_PASSWORD / KAFKA_GROUP_PREFIX 均已预设在容器环境中。启动输出写入 /workspace/deploy.log。

提示词示例

• “创建一个 1GB、持续运行的容器，并将 ./dist/app.tar.gz 部署到其中，告诉我 URL。”
• “显示我的 blue-fox 容器最近 100 行日志。”
• “我使用的是什么方案？可以运行多少个容器？”
• “与 [email protected] 共享我的容器 24 小时。”

许可证

MIT。BasicDeploy 是 Akacia 的产品（KVK 99629569，荷兰）。