What is Forge Mcp Server

The forge-mcp-server is a Model Context Protocol (MCP) server designed for managing Laravel Forge servers, sites, and deployments through the Laravel Forge API.

Use cases

Use cases for forge-mcp-server include automating server management tasks, deploying web applications, managing deployment scripts, and monitoring server performance.

How to use

To use forge-mcp-server, first obtain a Laravel Forge API key and set it as an environment variable. Then, you can run the server using ‘npx forge-mcp-server’ or integrate it into your project by importing the ForgeServer class and calling the run method.

Key features

Key features include listing and retrieving details of Laravel Forge servers, managing sites, deploying sites, toggling quick deploy functionality, viewing deployment history, rebooting servers, and checking server load.

Where to use

forge-mcp-server is primarily used in web development environments where Laravel Forge is utilized for server management and deployment automation.

Laravel Forge MCP Server

A Model Context Protocol (MCP) server for interacting with Laravel Forge API. This server enables AI assistants to manage Laravel Forge servers, sites, and deployments.

Features

• List and get details of Laravel Forge servers
• Manage sites on Laravel Forge servers
• Deploy sites and manage deployment scripts
• Toggle quick deploy functionality
• View deployment history
• Reboot servers and check server load

Installation

npm install @bretterer/forge-mcp-server

Usage

Prerequisites

You need a Laravel Forge API key to use this server. You can get one from your Laravel Forge account settings.

Environment Variables

Set your Laravel Forge API key as an environment variable:

export FORGE_API_KEY=your_forge_api_key

Running the Server

npx forge-mcp-server

Or add it to your project:

import { ForgeServer } from '@bretterer/forge-mcp-server';

const server = new ForgeServer();
server.run().catch(console.error);

Available Tools

The MCP server provides the following tools:

• list_servers - List all Laravel Forge servers
• get_server - Get details of a specific server
• list_sites - List all sites on a server
• get_site - Get details of a specific site
• deploy_site - Deploy a site
• get_deployments - Get deployment history for a site
• get_deployment_script - Get the deployment script for a site
• update_deployment_script - Update the deployment script for a site
• toggle_quick_deploy - Enable or disable quick deploy for a site
• reboot_server - Reboot a server
• get_server_load - Get server load metrics
• reset_deployment_state - Reset deployment state for a site

Development

Setup

git clone https://github.com/bretterer/forge-mcp-server.git
cd forge-mcp-server
npm install

Build

npm run build

Run in Development Mode

npm run dev

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.