forge-mcp-server
The Laravel Forge MCP server interacts with the Laravel Forge API, enabling management of servers, sites, and deployments. It is designed for AI assistants to efficiently perform tasks through Laravel Forge.
GitHub Stars
7
User Rating
Not Rated
Forks
0
Issues
0
Views
1
Favorites
0
README
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 serversget_server
- Get details of a specific serverlist_sites
- List all sites on a serverget_site
- Get details of a specific sitedeploy_site
- Deploy a siteget_deployments
- Get deployment history for a siteget_deployment_script
- Get the deployment script for a siteupdate_deployment_script
- Update the deployment script for a sitetoggle_quick_deploy
- Enable or disable quick deploy for a sitereboot_server
- Reboot a serverget_server_load
- Get server load metricsreset_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.