1.0.1 • Published 3 months ago

@shramiknakarmi/laravel-upgrade-mcp v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
3 months ago

Laravel Upgrade MCP Server

This project implements a Model Context Protocol (MCP) server that helps developers upgrade their Laravel projects from one version to another (e.g., 8.x to 9.x, 9.x to 10.x, etc.).

Setup

To run the Laravel Upgrade MCP server using npx, use the following command:

npx -y @shramiknakarmi/laravel-upgrade-mcp@latest

Usage with Cursor or Claude Desktop

Add the following configuration. For more information, read the Cursor MCP documentation or the Claude Desktop MCP guide.

{
  "mcpServers": {
    "laravel-upgrade-mcp": {
      "command": "npx",
      "args": ["-y", "@shramiknakarmi/laravel-upgrade-mcp@latest"]
    }
  }
}

On Windows, you might need to use this alternative configuration:

{
  "mcpServers": {
    "laravel-upgrade-mcp": {
      "command": "cmd",
      "args": ["/k", "npx", "-y", "@shramiknakarmi/laravel-upgrade-mcp@latest"]
    }
  }
}

Available tools

This MCP server provides the following tools:

Tool NameDescription
analyze_laravel_projectAnalyze a Laravel project for upgrade requirements
analyze_laravel_fileAnalyze a specific file for upgrade requirements
fetch_laravel_upgrade_guideFetch the official Laravel upgrade guide for a specific version

Available prompts

This MCP server provides the following prompts:

Prompt NameDescription
laravel_upgrade_assistantGet comprehensive guidance for upgrading Laravel projects
laravel_file_upgradeGet specific guidance for upgrading a particular file in a Laravel project

Features

  • Project Analysis: Scan Laravel project structure to identify files requiring updates
  • File-Specific Analysis: Analyze PHP, Blade, Config, Routes, and Composer files for upgrade requirements
  • Documentation Integration: Fetch relevant sections from the official Laravel upgrade guides
  • Code Modification Suggestions: Get specific recommendations for updating your code
  • Version Detection: Identify current Laravel version and determine the upgrade path
  • Dependency Analysis: Check for required dependency updates in composer.json

Development

The server is built using the MCP SDK and communicates with Laravel documentation.

  1. npm install
  2. Modify source files
  3. Run npm run build to compile
  4. Run npm run test to run tests
  5. Add an MCP server that runs this command: node <absolute_path_of_project>/dist/index.js

License

ISC

1.0.1

3 months ago

1.0.0

3 months ago