使用说明

项目简介

Heroku MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在使大型语言模型 (LLM) 能够无缝地与 Heroku 平台进行交互。它提供了一组工具和功能，允许 LLM 读取、管理和操作 Heroku 平台上的各种资源。

主要功能点

Heroku 平台资源交互: 通过 LLM 驱动的工具直接与 Heroku 平台资源进行交互。
安全认证访问: 利用 Heroku CLI 提供安全认证的 Heroku Platform API 访问。
自然语言界面: 为 Heroku 平台交互提供自然语言接口。
丰富的工具集: 提供应用管理、维护模式控制、日志查看、空间管理、团队管理、插件管理以及 PostgreSQL 数据库管理等多种工具。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm。
全局安装 Heroku MCP Server: 打开终端并执行以下命令进行全局安装：
```
npm -i -g @heroku/mcp-server
```

服务器配置

MCP 服务器需要配置在 MCP 客户端中，以便客户端能够连接并使用服务器提供的工具。以下是一些常见 MCP 客户端的配置示例。你需要将以下 JSON 配置添加到你的 MCP 客户端配置文件中。

Claude Desktop 配置示例 (claude_desktop_config.json):

"mcpServers": {
  "heroku": {
    "command": "heroku-mcp-server",  // MCP 服务器的启动命令，通常为安装的包名
    "env": {
      "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>" // 环境变量，用于Heroku API 认证，请替换为你的 Heroku 授权令牌
    }
  }
}

Zed 配置示例 (settings.json):

"context_servers": [
  "heroku-mcp-server": {
    "command": {
      "path": "heroku-mcp-server", // MCP 服务器可执行文件的路径，全局安装时通常为包名
      "env": {
        "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>" // 环境变量，用于Heroku API 认证，请替换为你的 Heroku 授权令牌
      }
    }
  }
],

Cursor 配置示例 (mcp.json):

"mcpServers": {
  "heroku": {
    "command": "heroku-mcp-server",  // MCP 服务器的启动命令，通常为安装的包名
    "env": {
      "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>" // 环境变量，用于Heroku API 认证，请替换为你的 Heroku 授权令牌
    }
  },
}

Windsurf 配置示例 (mcp_config.json):

"mcpServers": {
  "heroku": {
    "command": "heroku-mcp-server",  // MCP 服务器的启动命令，通常为安装的包名
    "env": {
      "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>" // 环境变量，用于Heroku API 认证，请替换为你的 Heroku 授权令牌
    }
  },
}

获取 Heroku 授权令牌 (HEROKU_API_KEY): 你需要一个 Heroku 授权令牌用于服务器的身份验证。可以通过以下方式获取：

Heroku Dashboard: 登录 Heroku 仪表板，在账户设置中生成授权令牌。
Heroku CLI: 安装 Heroku CLI 并运行命令 'heroku authorizations:create' 创建令牌。

将获取到的令牌替换配置中的 '<YOUR_HEROKU_AUTH_TOKEN>'。

基本使用方法

启动 MCP 服务器: 当 MCP 客户端启动并加载配置后，Heroku MCP Server 会自动在后台启动 (Stdio 传输协议)。
在 LLM 客户端中使用工具: 在支持 MCP 协议的 LLM 客户端中，你可以通过自然语言指令调用 Heroku MCP Server 提供的工具，例如：
- 列出 Heroku 应用
- 查看应用日志
- 开启或关闭应用维护模式
- 管理 PostgreSQL 数据库 (如查询信息、查看进程等)
- ... 等等。

具体工具的使用和参数可以参考工具的描述信息，或者通过客户端的工具列表查看。

注意: Heroku MCP Server 仍处于早期开发阶段，功能和工具可能会不断演进。

关键词