Forge

This MCP server provides comprehensive access to Laravel Forge's official API through MCP-compliant tools, enabling you to manage Forge servers and sites efficiently from your MCP client.

How to use

You connect to the Forge MCP Server from your MCP client to perform server and site management tasks using a dedicated set of tools. An API key is required to invoke Forge operations. You can enable both read-only and write tools by passing a tools flag to your MCP client, such as readonly alone for safe operations or readonly combined with write for full control.

How to install

Prerequisites you need before running the Forge MCP Server:

• Node.js (v18+ recommended)

• npm (v9+ recommended)

Forge MCP server configuration and usage patterns

You must provide a Forge API key to run Forge MCP tools. You have two interchangeable ways to provide it.

Option A: Use npx to run the Forge MCP package via Claude Desktop. You can pass the API key either as an environment variable or as a command-line argument.

Option 1: Using npx (Recommended)

{
  "mcpServers": {
    "forge-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@ranium/forge-mcp"
      ],
      "env": {
        "FORGE_API_KEY": "your_forge_api_key_here"
      }
    }
  }
}

Option 1b: Using command-line argument with npx

{
  "mcpServers": {
    "forge-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@ranium/forge-mcp",
        "--api-key=your_forge_api_key_here"
      ]
    }
  }
}

Option 2: Using node directly

First, clone the Forge MCP server repository, install dependencies, and build the project.

git clone https://github.com/ranium/forge-mcp-server
cd forge_mcp
npm install
npm run build

Then configure the MCP client to run the built server using node and the produced dist/server.js file.

Option 2a: Using environment variable with node

{
  "mcpServers": {
    "forge-mcp": {
      "command": "node",
      "args": [
        "/path/to/forge_mcp/dist/server.js"
      ],
      "env": {
        "FORGE_API_KEY": "your_forge_api_key_here"
      }
    }
  }
}

Option 2b: Using command-line argument with node

{
  "mcpServers": {
    "forge-mcp": {
      "command": "node",
      "args": [
        "/path/to/forge_mcp/dist/server.js",
        "--api-key=your_forge_api_key_here"
      ]
    }
  }
}

Notes on API key handling

You can provide the API key either via the FORGE_API_KEY environment variable or via the --api-key command-line argument. If both are supplied, the command-line argument takes precedence. Do not commit real API keys to version control; use environment variables or secrets management in production.

Tool access and usage

Forge MCP tools are divided into Readonly and Write categories. Readonly tools perform safe, non-modifying operations, while Write tools create or update resources. By default, only readonly tools are enabled. To enable write tools, include a tools specification that enables both readonly and write.

Security and best practices

Keep your API keys secure. Use environment variables or a secrets manager for production deployments. When sharing configurations, redact keys and replace them with placeholders like your_forge_api_key_here.

Examples and troubleshooting

If you encounter issues starting the server, verify that Node.js and npm versions satisfy the prerequisites, confirm the API key is correct, and ensure that the proper command and arguments are used for your chosen run method.

Available tools

list_servers

List all Forge servers accessible through the Forge MCP interface.

list_static_php_versions

List available static PHP versions supported by Forge.

list_php_versions

List all PHP versions that Forge can deploy.

get_user

Retrieve information about the Forge user associated with the API key.

show_server

Get detailed information about a specific Forge server.

list_sites

List all sites on a given Forge server.

show_site

Get detailed information about a specific site.

list_daemons

List daemon processes managed by Forge on your servers.

show_daemon

Get details for a specific daemon.

list_deployments

List deployments for a site or server.

get_deployment_log

Retrieve logs for a deployment.

get_deployment

Get details about a specific deployment.

get_deployment_output

Fetch the output of a deployment run.

get_server_logs

Retrieve server logs for troubleshooting.

list_providers

List supported cloud providers.

list_database_types

List available database types.

list_credentials

List stored credentials.

list_regions

List available regions for provisioning resources.

list_ubuntu_versions

List Ubuntu OS versions supported by Forge deployments.

get_composer_packages_auth

Retrieve Composer authentication details.

check_laravel_maintenance_status

Check if Laravel maintenance mode is enabled.

check_pulse_daemon_status

Check status of the Pulse daemon.

check_inertia_daemon_status

Check status of the Inertia daemon.

check_laravel_scheduler_status

Check status of Laravel scheduler.

list_sizes

List available server sizes.

list_project_types

List supported project types.

list_databases

List all databases.

get_database

Get details for a specific database.

list_database_users

List database users.

get_database_user

Get details about a specific database user.

list_certificates

List SSL certificates.

get_certificate

Get details about a specific certificate.

get_site_env

Retrieve the site environment file (.env).

get_site_log

Get logs for a site.