Phalcon

🚀 Phalcon MCP Server

A Model Context Protocol (MCP) server for executing Phalcon 5.0.x framework commands. This server allows AI assistants to create and manage Phalcon projects, controllers, models, etc.

🚀 Quick Start

Prerequisites

• Phalcon Framework
• Cursor IDE
• Python 3.x
• Installed Phalcon 5.0.x development tools: composer global require phalcon/devtools:"^5.0.x@dev" --dev

📦 Installation

Quick Installation

Use the provided installation script to install all dependencies:

python install.py

This script will install:

• The basic MCP server and its dependencies
• Required Python packages

💻 Usage in Cursor IDE

1. Open Cursor, navigate to Settings -> Cursor Settings -> MCP.
2. Click: Add new MCP server.
3. Name: Phalcon MCP; Type: Command.
4. Command: cmd /c uv run --with mcp[cli] mcp run <full path>/phalcon_mcp_server.py

    "phalcon-mcp": {
      "command": "cmd",
      "args": [
        "/c",
        "uv",
        "run",
        "--with",
        "mcp[cli]",
        "mcp",
        "run",
        "C:\\Users\\Administrator\\Desktop\\mcp\\phalcon-mcp\\phalcon_mcp_server.py"
      ]
    }

✨ Features

Available Tools

• phalcon_info - Display Phalcon version and environment information.
• phalcon_create_project - Create a new Phalcon project.
• phalcon_create_module - Create a new module.
• phalcon_create_controller - Create a new controller.
• phalcon_create_model - Create a new model.
• phalcon_create_all_models - Create models for all database tables.
• phalcon_create_migration - Create a new database migration.
• phalcon_create_scaffold - Create a complete CRUD scaffold.
• phalcon_create_webtools - Initialize Phalcon Webtools.
• phalcon_serve - Start the development server.
• phalcon_list_commands - List all available Phalcon commands.

💻 Usage Examples

Basic Usage

View Phalcon Information

Command: View Phalcon version and environment information.
Result: Display the currently installed Phalcon version and system environment information.

Create a New Project

Command: Create a new project named "my-app".
Parameters:
- template: basic (default), micro, or api.
- directory: The location where the project will be created.
Result: Create a new Phalcon project infrastructure.

Create a Module

Command: Create a new module named "admin".
Result: Create a new module in the project.

Create a Controller

Command: Create a new controller named "users".
Result: Create a new UsersController in the project.

Create a Model

Command: Create a new model named "User".
Result: Create a new User model in the project.

Create Models for All Database Tables

Command: Scan the database and generate models for all tables.
Result: Create models corresponding to all tables in the project.

Create a Database Migration

Command: Generate a migration file based on the current database state.
Result: Generate a new migration file to synchronize the database schema.

Create a Complete CRUD Scaffold

Command: Generate a complete CRUD functionality for the specified resource.
Result: Create controllers and views in the project to support CRUD operations.

Initialize Webtools

Command: Initialize the Phalcon Webtools project.
Result: Configure Webtools-related settings in the project.

Start the Development Server

Command: Start the Phalcon development server.
Result: Start the local development server to run the application.

List All Available Commands

Command: List all available Phalcon commands.
Result: Display a list of all supported Phalcon CLI commands.

🔧 Technical Details

The MCP server allows AI assistants to automate the development process by interacting with the Phalcon framework. It provides a series of commands for quickly creating and managing project components such as projects, modules, controllers, models, etc., and supports database migrations and web application development.

⚠️ Important Note

1. Ensure that the Phalcon Framework is correctly installed.
2. Ensure that the PHP environment variables are correctly configured.
3. On Windows systems, ensure that phalcon.bat is in the system path.

📄 License

MIT