heroku-mcp-server
The Heroku Platform MCP Server works on Common Runtime, Cedar Private and Shield Spaces, and Fir Private Spaces.
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.
Authentication
Generate a Heroku authorization token with one of these methods:
- Use the Heroku CLI command:
- Use an existing token in the CLICopy the token and use it as your
HEROKU_API_KEYin the following steps.
- In your Heroku Dashboard:
Configure the Heroku Platform MCP Server
You can configure Claude Desktop, Zed, Cursor, and Windsurf to work with the Heroku Platform MCP Server.
[Claude Desktop](https://claude.ai/download)
Add this snippet to your
claude_desktop_config.json:[Zed](https://github.com/zed-industries/zed)
Add this snippet to your Zed
settings.json:[Cursor](https://www.cursor.com/)
Add this snippet to your Cursor
mcp.json:[Windsurf](https://www.windsurf.com/)
Add this snippet to your Windsurf
mcp_config.json: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 anapp.jsonconfiguration, 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.
- Link the project as a global CLI using
npm linkfrom the project root.
- Build with
npm run build:devor watch for file changes and build automatically withnpm run build:watch.
Use the MCP Inspector
Use the MCP inspector with no breakpoints in the code:
Alternatively, if you installed the package in a specific directory or are actively developing on the Heroku MCP server:
Use the VS Code Run and Debug Function
Use the VS Code
Run and Debug launcher with fully
functional breakpoints in the code:
- Locate and select the run debug.
- Select the configuration labeled "
MCP Server Launcher" in the dropdown.
- Select the run/debug button.
VS Code / Cursor Debugging Setup
To set up local debugging with breakpoints:
- Store your Heroku auth token in the VS Code user settings:
- Create or update
.vscode/launch.json:
- Create
.vscode/tasks.json:
- (Optional) Set breakpoints in your TypeScript files.
- Press F5 or use the `Run and Debug` sidebar.
Note: the debugger automatically builds your TypeScript files before launching.
heroku-mcp-server
The Heroku Platform MCP Server works on Common Runtime, Cedar Private and Shield Spaces, and Fir Private Spaces.
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.
Authentication
Generate a Heroku authorization token with one of these methods:
- Use the Heroku CLI command:
- Use an existing token in the CLICopy the token and use it as your
HEROKU_API_KEYin the following steps.
- In your Heroku Dashboard:
Configure the Heroku Platform MCP Server
You can configure Claude Desktop, Zed, Cursor, and Windsurf to work with the Heroku Platform MCP Server.
[Claude Desktop](https://claude.ai/download)
Add this snippet to your
claude_desktop_config.json:[Zed](https://github.com/zed-industries/zed)
Add this snippet to your Zed
settings.json:[Cursor](https://www.cursor.com/)
Add this snippet to your Cursor
mcp.json:[Windsurf](https://www.windsurf.com/)
Add this snippet to your Windsurf
mcp_config.json: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 anapp.jsonconfiguration, 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.
- Link the project as a global CLI using
npm linkfrom the project root.
- Build with
npm run build:devor watch for file changes and build automatically withnpm run build:watch.
Use the MCP Inspector
Use the MCP inspector with no breakpoints in the code:
Alternatively, if you installed the package in a specific directory or are actively developing on the Heroku MCP server:
Use the VS Code Run and Debug Function
Use the VS Code
Run and Debug launcher with fully
functional breakpoints in the code:
- Locate and select the run debug.
- Select the configuration labeled "
MCP Server Launcher" in the dropdown.
- Select the run/debug button.
VS Code / Cursor Debugging Setup
To set up local debugging with breakpoints:
- Store your Heroku auth token in the VS Code user settings:
- Create or update
.vscode/launch.json:
- Create
.vscode/tasks.json:
- (Optional) Set breakpoints in your TypeScript files.
- Press F5 or use the `Run and Debug` sidebar.
Note: the debugger automatically builds your TypeScript files before launching.