Heroku Mcp 服务器

什么是 Heroku MCP 服务器？

Heroku MCP 服务器是一个强大的工具，旨在增强 Heroku 平台的功能。它允许开发者使用 Heroku 命令行界面（CLI）更高效地管理他们的应用程序。该服务器充当 Heroku 平台与开发者之间的桥梁，为部署和管理应用程序提供无缝体验。

Heroku MCP 服务器的特点

• 与 Heroku CLI 的集成：该服务器与 Heroku CLI 完全集成，允许用户直接从终端执行命令。
• 用户友好的界面：它提供了一个简单明了的界面，简化了应用程序的管理，使开发者更容易部署和监控他们的项目。
• 实时监控：用户可以实时监控他们的应用程序，接收有关性能和问题的更新和警报。
• 可扩展性：Heroku MCP 服务器旨在与您的应用程序一起扩展，确保在用户基础增长时能够处理增加的负载。
• 开源：作为一个公共代码库，开发者可以参与其开发，确保持续改进和功能增强。

如何使用 Heroku MCP 服务器

1. 安装：首先在您的机器上安装 Heroku CLI。您可以在 Heroku 网站 上找到安装说明。
2. 克隆代码库：使用以下命令从 GitHub 克隆 Heroku MCP 服务器代码库：

   git clone https://github.com/heroku/heroku-mcp-server.git
   

3. 进入目录：切换到克隆的代码库目录：

   cd heroku-mcp-server
   

4. 运行服务器：使用以下命令启动服务器：

   heroku-mcp-server start
   

5. 访问界面：打开您的浏览器，导航到服务器的 URL，以访问用户界面并开始管理您的应用程序。

常见问题解答

Heroku MCP 服务器的目的是什么？

Heroku MCP 服务器旨在促进在 Heroku 平台上管理应用程序，为开发者提供有效部署、监控和扩展应用程序的工具。

Heroku MCP 服务器是免费使用的吗？

是的，Heroku MCP 服务器是开源的，免费提供给用户。开发者可以参与其开发并免费使用。

我可以为 Heroku MCP 服务器做贡献吗？

当然可以！Heroku MCP 服务器是一个公共代码库，欢迎贡献。您可以提交问题、功能请求，甚至拉取请求，以增强服务器的功能。

Heroku MCP 服务器支持哪些编程语言？

Heroku MCP 服务器主要支持在 Heroku 平台上构建的应用程序，包括 Ruby、Node.js、Python、Java 等多种编程语言。

我该如何报告问题或错误？

如果您在使用 Heroku MCP 服务器时遇到任何问题或错误，可以在 GitHub 代码库的问题跟踪器上报告。请确保提供有关问题的详细信息，以帮助开发者快速解决。

heroku-mcp-server

The Heroku Platform MCP Server works on Common Runtime, Cedar Private and Shield Spaces, and Fir Private Spaces.

Prerequisites

• Heroku CLI must be installed globally on your system, version 10.8.1 or higher.
  • Install or upgrade the Heroku CLI

Deploy on Heroku

Overview

The Heroku Platform MCP Server is a specialized Model Context Protocol (MCP) implementation designed to facilitate seamless interaction between large language models (LLMs) and the Heroku Platform. This server provides a robust set of tools and capabilities that enable LLMs to read, manage, and operate Heroku Platform resources.

Key Features:

• Direct interaction with Heroku Platform resources through LLM-driven tools
• Secure and authenticated access to Heroku Platform APIs, leveraging the Heroku CLI
• Natural language interface for Heroku Platform interactions

Note: The Heroku Platform MCP Server is currently in early development. As we continue to enhance and refine the implementation, the available functionality and tools may evolve. We welcome feedback and contributions to help shape the future of this project.

Note: The Heroku Platform MCP Server requires the Heroku CLI to be installed globally (v10.8.1+). Ensure you have the correct version by running heroku --version.

Configure the Heroku Platform MCP Server

You can configure Claude Desktop, Zed, Cursor, Windsurf, and other clients to work with the Heroku Platform MCP Server.

Configure the Heroku Platform MCP Server with heroku mcp:start

Use heroku mcp:start to launch the Heroku Platform MCP Server. We recommend this method as it leverages your existing Heroku CLI authentication, so you don't need to set the HEROKU_API_KEY environment variable. The heroku mcp:start command is available in Heroku CLI version 10.8.1 and later.

There are several benefits to configuring with heroku mcp:start:

• No need to manage or expose your Heroku API key
• Uses your current Heroku CLI authentication context
• Works seamlessly with supported clients

Example configuration for Claude Desktop:

{
  "mcpServers": {
    "heroku": {
      "command": "heroku mcp:start"
    }
  }
}

Example configuration for Zed:

{
  "context_servers": {
    "heroku": {
      "command": {
        "path": "heroku",
        "args": ["mcp:start"]
      }
    }
  }
}

Example configuration for Cursor:

{
  "mcpServers": {
    "heroku": {
      "command": "heroku mcp:start"
    }
  }
}

Example configuration for Windsurf:

{
  "mcpServers": {
    "heroku": {
      "command": "heroku mcp:start"
    }
  }
}

Example configuration for Cline:

{
  "mcpServers": {
    "heroku": {
      "command": "heroku mcp:start"
    }
  }
}

Example configuration for VSCode:

{
  "mcp": {
    "servers": {
      "heroku": {
        "type": "stdio",
        "command": "heroku",
        "args": ["mcp:start"]
      }
    }
  }
}

Example configuration for Trae:

{
  "mcpServers": {
    "heroku": {
      "command": "heroku mcp:start"
    }
  }
}

Note: When you use heroku mcp:start, the server authenticates using your current Heroku CLI session so you don't need to set the HEROKU_API_KEY environment variable. We recommend you use heroku mcp:start, but if you prefer to use an API key, you can use the alternate configuration below.

Configure the Heroku Platform MCP Server with npx -y @heroku/mcp-server

You can also launch the Heroku Platform MCP Server using the npx -y @heroku/mcp-server command. This method requires you to set the HEROKU_API_KEY environment variable with your Heroku authorization token.

Generating the HEROKU_API_KEY

Generate a Heroku authorization token with one of these methods:

• Use the Heroku CLI command:

    heroku authorizations:create
  

• Use an existing token in the CLI

    heroku auth:token
  

  Copy the token and use it as your HEROKU_API_KEY in the following steps.

• In your Heroku Dashboard:

  1. Select your avatar, then select Account Settings.
  2. Open the Applications tab.
  3. Next to Authorizations, click Create authorization.

Example configuration for Claude Desktop:

{
  "mcpServers": {
    "heroku": {
      "command": "npx",
      "args": ["-y", "@heroku/mcp-server"],
      "env": {
        "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>"
      }
    }
  }
}

Example configuration for Zed:

{
  "context_servers": {
    "heroku": {
      "command": {
        "path": "npx",
        "args": ["-y", "@heroku/mcp-server"],
        "env": {
          "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>"
        }
      }
    }
  }
}

Example configuration for Cursor:

{
  "mcpServers": {
    "heroku": {
      "command": "npx -y @heroku/mcp-server",
      "env": {
        "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>"
      }
    }
  }
}

Example configuration for Windsurf:

{
  "mcpServers": {
    "heroku": {
      "command": "npx",
      "args": ["-y", "@heroku/mcp-server"],
      "env": {
        "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>"
      }
    }
  }
}

Example configuration for Cline:

{
  "mcpServers": {
    "heroku": {
      "command": "npx",
      "args": ["-y", "@heroku/mcp-server"],
      "env": {
        "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>"
      }
    }
  }
}

Example configuration for VSCode:

{
  "mcp": {
    "servers": {
      "heroku": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "@heroku/mcp-server"],
        "env": {
          "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>"
        }
      }
    }
  }
}

Example configuration for Trae:

{
  "mcpServers": {
    "heroku": {
      "command": "npx",
      "args": ["-y", "@heroku/mcp-server"],
      "env": {
        "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>"
      }
    }
  }
}

Note: When you use npx -y @heroku/mcp-server, you must set the HEROKU_API_KEY environment variable with your Heroku authorization token.

Available Tools

Application Management

• list_apps - List all Heroku apps. You can filter apps by personal, collaborator, team, or space.
• get_app_info - Get detailed information about an app, including its configuration, dynos, and add-ons.
• create_app - Create a new app with customizable settings for region, team, and space.
• rename_app - Rename an existing app.
• transfer_app - Transfer ownership of an app to another user or team.
• deploy_to_heroku - Deploy projects to Heroku with an app.json configuration, supporting team deployments, private spaces, and environment setups.
• deploy_one_off_dyno - Execute code or commands in a sandboxed environment on a Heroku one-off dyno. Supports file creation, network access, environment variables, and automatic cleanup. Ideal for running scripts, tests, or temporary workloads.

Process & Dyno Management

• ps_list - List all dynos for an app.
• ps_scale - Scale the number of dynos up or down, or resize dynos.
• ps_restart - Restart specific dynos, process types, or all dynos.

Add-ons

• list_addons - List all add-ons for all apps or for a specific app.
• get_addon_info - Get detailed information about a specific add-on.
• create_addon - Provision a new add-on for an app.

Maintenance & Logs

• maintenance_on - Enable maintenance mode for an app.
• maintenance_off - Disable maintenance mode for an app.
• get_app_logs - View application logs.

Pipeline Management

• pipelines_create - Create a new pipeline.
• pipelines_promote - Promote apps to the next stage in a pipeline.
• pipelines_list - List available pipelines.
• pipelines_info - Get detailed pipeline information.

Team & Space Management

• list_teams - List teams you belong to.
• list_private_spaces - List available spaces.

PostgreSQL Database Management

• pg_psql - Execute SQL queries against the Heroku PostgreSQL database.
• pg_info - Display detailed database information.
• pg_ps - View active queries and execution details.
• pg_locks - View database locks and identify blocking transactions.
• pg_outliers - Identify resource-intensive queries.
• pg_credentials - Manage database credentials and access.
• pg_kill - Terminate specific database processes.
• pg_maintenance - Show database maintenance information.
• pg_backups - Manage database backups and schedules.
• pg_upgrade - Upgrade PostgreSQL to a newer version.

Debugging

You can use the MCP inspector or the VS Code Run and Debug function to run and debug the server.

1. Link the project as a global CLI using npm link from the project root.
2. Build with npm run build:dev or watch for file changes and build automatically with npm run build:watch.

Use the MCP Inspector

Use the MCP inspector with no breakpoints in the code:

### Breakpoints are not available
npx @modelcontextprotocol/inspector heroku-mcp-server

Alternatively, if you installed the package in a specific directory or are actively developing on the Heroku MCP server:

cd /path/to/servers
npx @modelcontextprotocol/inspector dist/index.js

Use the VS Code Run and Debug Function

Use the VS Code Run and Debug launcher with fully functional breakpoints in the code:

1. Locate and select the run debug.
2. Select the configuration labeled "MCP Server Launcher" in the dropdown.
3. Select the run/debug button.

VS Code / Cursor Debugging Setup

To set up local debugging with breakpoints:

1. Store your Heroku auth token in the VS Code user settings:

   • Open the Command Palette (Cmd/Ctrl + Shift + P).
   • Type Preferences: Open User Settings (JSON).
   • Add the following snippet:

   {
     "heroku.mcp.authToken": "your-token-here"
   }
   

2. Create or update .vscode/launch.json:

   {
     "version": "0.2.0",
     "configurations": [
       {
         "type": "node",
         "request": "launch",
         "name": "MCP Server Launcher",
         "skipFiles": ["<node_internals>/**"],
         "program": "${workspaceFolder}/node_modules/@modelcontextprotocol/inspector/bin/cli.js",
         "outFiles": ["${workspaceFolder}/**/dist/**/*.js"],
         "env": {
           "HEROKU_API_KEY": "${config:heroku.mcp.authToken}",
           "DEBUG": "true"
         },
         "args": ["heroku-mcp-server"],
         "sourceMaps": true,
         "console": "integratedTerminal",
         "internalConsoleOptions": "neverOpen",
         "preLaunchTask": "npm: build:watch"
       },
       {
         "type": "node",
         "request": "attach",
         "name": "Attach to Debug Hook Process",
         "port": 9332,
         "skipFiles": ["<node_internals>/**"],
         "sourceMaps": true,
         "outFiles": ["${workspaceFolder}/dist/**/*.js"]
       },
       {
         "type": "node",
         "request": "attach",
         "name": "Attach to REPL Process",
         "port": 9333,
         "skipFiles": ["<node_internals>/**"],
         "sourceMaps": true,
         "outFiles": ["${workspaceFolder}/dist/**/*.js"]
       }
     ],
     "compounds": [
       {
         "name": "Attach to MCP Server",
         "configurations": ["Attach to Debug Hook Process", "Attach to REPL Process"]
       }
     ]
   }
   

3. Create .vscode/tasks.json:

   {
     "version": "2.0.0",
     "tasks": [
       {
         "type": "npm",
         "script": "build:watch",
         "group": {
           "kind": "build",
           "isDefault": true
         },
         "problemMatcher": ["$tsc"]
       }
     ]
   }
   

4. (Optional) Set breakpoints in your TypeScript files.

5. Press F5 or use the Run and Debug sidebar.

Note: the debugger automatically builds your TypeScript files before launching.

Installing via Smithery

To install Heroku Platform MCP Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @heroku/heroku-mcp-server --client claude

Environment Variables

The Heroku Platform MCP Server supports the following environment variables:

HEROKU_API_KEY

Your Heroku authorization token. Required for authentication with the Heroku Platform.

MCP_SERVER_REQUEST_TIMEOUT

Timeout in milliseconds for command execution. Defaults to 15000 (15 seconds) if not set.

Example configuration with custom timeout:

{
  "mcpServers": {
    "heroku": {
      "command": "npx",
      "args": ["-y", "@heroku/mcp-server"],
      "env": {
        "HEROKU_API_KEY": "<YOUR_HEROKU_AUTH_TOKEN>",
        "MCP_SERVER_REQUEST_TIMEOUT": "30000"
      }
    }
  }
}