### Install Heroku Platform MCP Server via Smithery CLI Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Provides the command-line instruction to automatically install the Heroku Platform MCP Server for Claude Desktop. This installation is facilitated using the Smithery command-line interface, simplifying the setup process. ```bash npx -y @smithery/cli install @heroku/heroku-mcp-server --client claude ``` -------------------------------- ### Example Configuration for Heroku MCP Server with Environment Variables Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Demonstrates how to configure the Heroku MCP Server within a JSON structure, specifically showing how to set environment variables like `HEROKU_API_KEY` for authentication and `MCP_SERVER_REQUEST_TIMEOUT` to customize the command execution timeout. This snippet provides a practical example for integrating these settings. ```json { "mcpServers": { "heroku": { "command": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "", "MCP_SERVER_REQUEST_TIMEOUT": "30000" } } } } ``` -------------------------------- ### Apache License 2.0 Boilerplate Notice Source: https://github.com/heroku/heroku-mcp-server/blob/main/LICENSE.txt This snippet contains the full text of the Apache License, Version 2.0 boilerplate notice. It should be included at the top of source files, enclosed in the appropriate comment syntax for the file format. Users must replace '{yyyy}' with the copyright year and '{name of copyright owner}' with their name or entity. ```Plaintext Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ``` -------------------------------- ### Importing Salesforce Testkit for Testing Source: https://github.com/heroku/heroku-mcp-server/blob/main/CONTRIBUTING.md This code snippet demonstrates how to import the Salesforce testkit, `com.salesforce.op.test._`, which provides a collection of testing utilities. It is typically used in test files (e.g., Scala or Java) to leverage existing testing facilities for writing comprehensive and robust tests, as suggested in the contribution guidelines. ```Scala import com.salesforce.op.test._ ``` -------------------------------- ### Build and Debug Heroku MCP Server with MCP Inspector Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This snippet provides initial setup commands for debugging the Heroku MCP server, including linking the project globally and building it. It then shows how to use the MCP inspector for debugging without breakpoints, either directly or from a specific directory. ```Shell npm link npm run build:dev ``` ```Shell npm run build:watch ``` ```Shell # Breakpoints are not available npx @modelcontextprotocol/inspector heroku-mcp-server ``` ```Shell cd /path/to/servers npx @modelcontextprotocol/inspector dist/index.js ``` -------------------------------- ### Heroku Add-ons Management API Tools Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This section provides API tools for managing Heroku add-ons, including operations for listing, getting information, and provisioning add-ons. ```APIDOC 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. ``` -------------------------------- ### Heroku Pipeline Management API Tools Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This section describes API tools for managing Heroku pipelines, including creating, promoting, listing, and getting information about pipelines. ```APIDOC 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. ``` -------------------------------- ### Heroku Application Management API Tools Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This section lists API tools available for managing Heroku applications, including operations for listing, getting information, creating, renaming, transferring, and deploying applications and one-off dynos. ```APIDOC 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. ``` -------------------------------- ### Configure Claude Desktop for Heroku MCP Server Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Add this JSON snippet to your `claude_desktop_config.json` to integrate the Heroku Platform MCP Server, specifying the `npx` command and `HEROKU_API_KEY` environment variable. ```json { "mcpServers": { "heroku": { "command": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "" } } } } ``` -------------------------------- ### Heroku Process and Dyno Management API Tools Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This section details API tools for managing Heroku dynos and processes, covering listing, scaling, and restarting dynos. ```APIDOC 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. ``` -------------------------------- ### Configure Zed for Heroku MCP Server Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Add this JSON snippet to your Zed `settings.json` to enable the Heroku Platform MCP Server, defining the `npx` command and `HEROKU_API_KEY` environment variable. ```json { "context_servers": { "heroku": { "command": { "path": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "" } } } } } ``` -------------------------------- ### VS Code Debug Launch and Attach Configurations for Heroku MCP Server Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Defines multiple debugging configurations for the Heroku MCP server within VS Code's `launch.json`. This includes launching the server, attaching to debug hook processes, and attaching to REPL processes. A compound configuration allows simultaneous attachment to both debug hook and REPL processes for comprehensive debugging. ```json { "version": "0.2.0", "configurations": [ { "type": "node", "request": "launch", "name": "MCP Server Launcher", "skipFiles": ["/**"], "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": ["/**"], "sourceMaps": true, "outFiles": ["${workspaceFolder}/dist/**/*.js"] }, { "type": "node", "request": "attach", "name": "Attach to REPL Process", "port": 9333, "skipFiles": ["/**"], "sourceMaps": true, "outFiles": ["${workspaceFolder}/dist/**/*.js"] } ], "compounds": [ { "name": "Attach to MCP Server", "configurations": ["Attach to Debug Hook Process", "Attach to REPL Process"] } ] } ``` -------------------------------- ### Configure VSCode for Heroku MCP Server Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Add this JSON snippet to your VSCode `settings.json` or `.vscode/mcp.json` to integrate the Heroku Platform MCP Server, specifying the `npx` command, `stdio` type, and `HEROKU_API_KEY` environment variable. ```json { "mcp": { "servers": { "heroku": { "type": "stdio", "command": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "" } } } } } ``` -------------------------------- ### Configure Cursor for Heroku MCP Server (Simple Command) Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Add this JSON snippet to your Cursor `mcp.json` using the simple command form to integrate the Heroku Platform MCP Server, including the `HEROKU_API_KEY`. ```json { "mcpServers": { "heroku": { "command": "npx -y @heroku/mcp-server", "env": { "HEROKU_API_KEY": "" } } } } ``` -------------------------------- ### Heroku Platform MCP Server Environment Variables Reference Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Detailed documentation for the environment variables supported by the Heroku Platform MCP Server. This includes `HEROKU_API_KEY`, which is essential for authentication with the Heroku Platform, and `MCP_SERVER_REQUEST_TIMEOUT`, which allows customization of the command execution timeout. ```APIDOC HEROKU_API_KEY: Description: Your Heroku authorization token. Required for authentication with the Heroku Platform. MCP_SERVER_REQUEST_TIMEOUT: Description: Timeout in milliseconds for command execution. Defaults to 15000 (15 seconds) if not set. Default: 15000 (15 seconds) ``` -------------------------------- ### Configure Windsurf for Heroku MCP Server Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Add this JSON snippet to your Windsurf `mcp_config.json` to integrate the Heroku Platform MCP Server, specifying the `npx` command and `HEROKU_API_KEY` environment variable. ```json { "mcpServers": { "heroku": { "command": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "" } } } } ``` -------------------------------- ### Configure Heroku MCP Server for Trae Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This JSON snippet shows how to add the Heroku MCP server configuration to your Trae `mcp_settings.json` file. It specifies the command to run the server and sets the `HEROKU_API_KEY` environment variable for authentication. ```JSON { "mcpServers": { "heroku": { "command": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "" } } } } ``` -------------------------------- ### Heroku PostgreSQL Database Management API Tools Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This section details API tools for managing Heroku PostgreSQL databases, covering SQL execution, information display, process viewing, lock identification, query analysis, credential management, process termination, maintenance, backups, and upgrades. ```APIDOC 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. ``` -------------------------------- ### VS Code Task for Building Heroku MCP Server Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Configures a VS Code task in `tasks.json` to run the `npm build:watch` script. This task is set as the default build task and is automatically executed as a pre-launch task during debugging, ensuring TypeScript files are built before the server launches. ```json { "version": "2.0.0", "tasks": [ { "type": "npm", "script": "build:watch", "group": { "kind": "build", "isDefault": true }, "problemMatcher": ["$tsc"] } ] } ``` -------------------------------- ### Generate Heroku API Key using CLI Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Provides commands to create a new Heroku authorization token or retrieve an existing one from the CLI for use as your `HEROKU_API_KEY`. ```sh heroku authorizations:create ``` ```sh heroku auth:token ``` -------------------------------- ### Configure Cursor for Heroku MCP Server (Explicit Command) Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Add this JSON snippet to your Cursor `mcp.json` using the explicit command form to integrate the Heroku Platform MCP Server, including the `HEROKU_API_KEY`. ```json { "mcpServers": { "heroku": { "command": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "" } } } } ``` -------------------------------- ### Configure Cline for Heroku MCP Server Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Add this JSON snippet to your Cline `config.json` to integrate the Heroku Platform MCP Server, specifying the `npx` command and `HEROKU_API_KEY` environment variable. ```json { "mcpServers": { "heroku": { "command": "npx", "args": ["-y", "@heroku/mcp-server"], "env": { "HEROKU_API_KEY": "" } } } } ``` -------------------------------- ### Heroku Team and Space Management API Tools Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This section lists API tools for managing teams and private spaces within Heroku. ```APIDOC Team & Space Management: list_teams: List teams you belong to. list_private_spaces: List available spaces. ``` -------------------------------- ### Configure Heroku Auth Token in VS Code User Settings Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md Instructions to add your Heroku authentication token to VS Code's user settings JSON file, enabling the Heroku MCP server to authenticate with the Heroku Platform. This token is crucial for the server's operation. ```json { "heroku.mcp.authToken": "your-token-here" } ``` -------------------------------- ### Heroku Maintenance and Logs API Tools Source: https://github.com/heroku/heroku-mcp-server/blob/main/README.md This section outlines API tools for managing application maintenance mode and viewing logs on Heroku. ```APIDOC Maintenance & Logs: maintenance_on: Enable maintenance mode for an app. maintenance_off: Disable maintenance mode for an app. get_app_logs: View application logs. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.