项目简介
Koyeb MCP 服务端是一个基于 Model Context Protocol (MCP) 的后端实现,专门用于与 Koyeb 云平台进行交互。它将 Koyeb 的各项 API 功能封装成标准化的 MCP 工具,使大型语言模型 (LLM) 客户端能够通过 JSON-RPC 协议直接管理 Koyeb 上的应用、服务、部署和实例等云资源,并执行相关操作。
主要功能点
- 应用管理: 列出、获取和创建 Koyeb 平台上的应用。
- 服务管理: 在现有应用内部列出、获取、创建和更新各种服务。
- 部署管理: 列出和获取部署的详细信息,并查询其构建日志和运行时日志。
- 实例管理: 获取部署或服务下所有运行实例的详细信息。
- 一键部署应用: 列出 Koyeb 平台提供的预设(示例)一键部署应用。
- 命令行执行: 在运行中的部署实例容器内执行指定的 shell 命令。
- 目录部署: 将本地指定目录中的代码或文件打包并部署到 Koyeb 平台,自动创建或更新服务。
安装步骤
- 安装 Node.js 和 npm: 确保您的系统已安装 Node.js 及其包管理器 npm。您可以从 Node.js 官方网站 下载安装。
- 全局安装 Koyeb MCP 服务端包:
打开您的终端或命令行工具,运行以下命令:
npm install -g @koyeb/mcp-server - 获取 Koyeb API 令牌: 在 Koyeb 官方网站创建并获取您的 API 访问令牌。请访问 Koyeb API 设置页面 生成新令牌。
- 设置环境变量:
将您的 Koyeb API 令牌设置为名为 'KOYEB_TOKEN' 的环境变量。这是 MCP 服务器连接 Koyeb API 所必需的凭证。
在 Linux/macOS 系统中,您可以在终端中运行:
在 Windows 系统中,可以使用:export KOYEB_TOKEN=您的Koyeb_API_令牌_在此处
为了持久化,建议将此环境变量添加到您的 shell 配置文件(如 '.bashrc', '.zshrc', '.profile' 或 Windows 的系统环境变量)。set KOYEB_TOKEN=您的Koyeb_API_令牌_在此处
服务器配置(适用于MCP客户端)
您的 MCP 客户端(如 Cursor、Claude Desktop 等)需要配置 MCP 服务器的连接信息。请将以下 JSON 配置片段添加到您的客户端配置文件中(通常是 '.cursor/mcp.json' 或 'claude_desktop_config.json')。
{ "mcpServers": { "koyebApi": { // 用于启动MCP服务器进程的命令,这里使用 npx 来执行安装好的包 "command": "npx", // 传递给启动命令的参数,用于指定要运行的MCP服务器包 "args": ["-y", "@koyeb/mcp-server"], // MCP服务器进程所需的环境变量,KOYEB_TOKEN 是必填项 "env": { "KOYEB_TOKEN": "您的Koyeb API令牌" // 请替换为您的实际 Koyeb API 令牌 } } } }
重要提示: 请将 '"您的Koyeb API令牌"' 替换为您在 Koyeb 网站上生成的真实 API 令牌。
基本使用方法
完成上述配置后,您的 MCP 客户端将能够发现并连接 Koyeb MCP 服务端。您可以通过自然语言向 LLM 客户端发出指令,例如:
- "列出我在 Koyeb 上的所有应用程序。"
- "创建一个名为 'my-web-app' 的新 Koyeb 应用。"
- "获取 ID 为 'svc-xxxxxxxxxxxx' 的服务详情,该服务属于 'my-web-app' 应用。"
- "查询应用 'my-cool-app' 中最新部署的运行时日志。"
- "在应用 'my-api-service' 的某个运行实例中执行 'cat /etc/os-release' 命令。"
- "将当前目录下的代码部署为名为 'new-feature-service' 的服务,并指定属于 'production-app' 应用。"
LLM 客户端会根据这些自然语言指令,智能地调用 Koyeb MCP 服务端提供的相应工具来执行操作,并将结果或反馈返回给您。
信息
分类
开发者工具