PHPackages                             took/yii2-gii-mcp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. took/yii2-gii-mcp

ActiveLibrary[Framework](/categories/framework)

took/yii2-gii-mcp
=================

Model Context Protocol (MCP) server for Yii2 Gii scaffolding - enables AI agents to generate models and CRUD interfaces

v1.1.1(4mo ago)813↓100%2MITPHPPHP >=8.2CI passing

Since Jan 3Pushed 2mo agoCompare

[ Source](https://github.com/took/yii2-gii-mcp)[ Packagist](https://packagist.org/packages/took/yii2-gii-mcp)[ Docs](https://github.com/took/yii2-gii-mcp)[ RSS](/packages/took-yii2-gii-mcp/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (7)Used By (0)

yii2-gii-mcp
============

[](#yii2-gii-mcp)

**MCP server for AI-powered Yii2 code generation and scaffolding**

yii2-gii-mcp is a PHP-based [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that enables AI assistants (Firebender, Claude Desktop, Cline, etc.) to interact with **Yii2's Gii code generator**. This allows AI agents to inspect your database, generate ActiveRecord models, create CRUD interfaces, and scaffold complete application components—all through natural language conversations.

> **Note:** This MCP server works exclusively with **Yii2 framework projects**. Yii1 and Yii3 are not supported.

Key Features
------------

[](#key-features)

- **Database Inspection** - List tables, columns, relationships, indexes, and constraints
- **Model Generation** - Create ActiveRecord models from database tables with relations
- **CRUD Scaffolding** - Generate complete CRUD operations (controllers, views, search models)
- **Controller Generation** - Create custom controllers with specific actions
- **Form Generation** - Generate form models for data collection and validation
- **Module Scaffolding** - Create complete Yii2 modules with directory structure
- **Extension Scaffolding** - Generate extension boilerplate with Composer packaging
- **Migration Management** - List, preview, and execute database migrations with safety confirmations
- **Project Structure Detection** - Auto-detect template type, applications, modules, and environment configuration
- **Component Inspection** - Analyze controllers, models, and views with detailed metadata extraction
- **Log Reading** - Read and filter application logs from files and database with advanced filtering
- **Preview-First Workflow** - Review all code before writing to disk (safety built-in)
- **Full MCP Support** - JSON-RPC 2.0 over stdio, works with any MCP client

Requirements
------------

[](#requirements)

- PHP 8.2 or higher
- Composer
- **Yii2 framework** (provided by your project)
- Yii2 Gii module (provided by your project)

**Important:** This MCP server is designed exclusively for **Yii2 framework projects**. Yii1 and Yii3 are not supported. If you're using Yii1, please migrate to Yii2 first using the [official Yii2 upgrade guide](https://www.yiiframework.com/doc/guide/2.0/en/intro-upgrade-from-v1).

Quick Start
-----------

[](#quick-start)

### 1. Installation

[](#1-installation)

Install into your existing Yii2 project via Composer:

```
cd /path/to/your/yii2/project
composer require took/yii2-gii-mcp
```

### 2. Setup (Interactive)

[](#2-setup-interactive)

Run the interactive setup wizard to configure everything automatically:

```
php vendor/took/yii2-gii-mcp/bin/interactive-setup
```

This wizard will:

- Detect your Yii2 project structure (Basic/Advanced Template)
- Create `config-mcp.php` configuration file
- Test your database connection
- Configure Firebender or Claude Desktop
- Verify the setup

**That's it!** Restart your IDE/client and you're ready to use it.

### 3. Manual Setup (Alternative)

[](#3-manual-setup-alternative)

If you prefer manual configuration:

#### Create config-mcp.php

[](#create-config-mcpphp)

```
cp vendor/took/yii2-gii-mcp/examples/config-advanced-template.php config-mcp.php
```

This smart config template automatically detects your Yii2 structure (Basic/Advanced/Advanced+API).

**Important:** Add to `.gitignore`:

```
echo "config-mcp.php" >> .gitignore
```

#### Configure Your MCP Client

[](#configure-your-mcp-client)

**For Firebender (Global - recommended):**

Edit `~/.firebender/firebender.json`:

```
{
  "mcpServers": {
    "yii2-gii": {
      "command": "php",
      "args": [
        "${workspaceFolder}/vendor/took/yii2-gii-mcp/bin/yii2-gii-mcp"
      ],
      "env": {
        "YII2_CONFIG_PATH": "${workspaceFolder}/config-mcp.php",
        "YII2_APP_PATH": "${workspaceFolder}"
      }
    }
  }
}
```

**For Claude Desktop:**

Edit your Claude config file:

- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
- **Linux**: `~/.config/Claude/claude_desktop_config.json`

```
{
  "mcpServers": {
    "yii2-gii": {
      "command": "php",
      "args": [
        "/absolute/path/to/your/project/vendor/took/yii2-gii-mcp/bin/yii2-gii-mcp"
      ],
      "env": {
        "YII2_CONFIG_PATH": "/absolute/path/to/your/project/config-mcp.php",
        "YII2_APP_PATH": "/absolute/path/to/your/project"
      }
    }
  }
}
```

**Note:** Use absolute paths for Claude Desktop!

**For Claude Code (CLI):**

Add the MCP server to your project:

```
claude mcp add yii2-gii-mcp --scope project \
  -e YII2_CONFIG_PATH=/path/to/your/project/config-mcp.php \
  -e YII2_APP_PATH=/path/to/your/project \
  -- php /path/to/your/project/vendor/took/yii2-gii-mcp/bin/yii2-gii-mcp
```

Then add the allowed tools to your `.claude/settings.json`:

```
{
  "allowedTools": [
    "mcp__yii2-gii-mcp:*"
  ]
}
```

This allows all yii2-gii-mcp tools to run without requiring manual approval for each call.

**Note:** Use absolute paths! The `--scope project` option stores the configuration in `.mcp.json` in your project directory.

### 4. Docker Setup

[](#4-docker-setup)

**If your Yii2 project runs in Docker Desktop**, see the Docker-specific guide:

**→ [docs/DOCKER.md](docs/DOCKER.md)**

This covers:

- Two setup options: MCP on host (recommended) or inside container
- Database connection configuration for Docker
- Firebender and Claude Desktop configs for Docker
- Troubleshooting Docker-specific issues
- Example configurations and wrapper scripts

**Quick Docker Start (Host-Based - Recommended):**

```
# 1. Install on host (faster, simpler)
composer require took/yii2-gii-mcp

# 2. Run interactive setup
php vendor/took/yii2-gii-mcp/bin/interactive-setup
# Configure database as 127.0.0.1:3306 (Docker exposes ports to host)

# 3. Configure Firebender with examples/docker/firebender-host.json
# 4. Restart PhpStorm - Done!
```

For container-based setup or troubleshooting, see the [full Docker guide](docs/DOCKER.md).

### 5. Verify Installation

[](#5-verify-installation)

Test your setup with the diagnostic tool:

```
php vendor/took/yii2-gii-mcp/bin/diagnose
```

Or test manually:

```
YII2_CONFIG_PATH=config-mcp.php php vendor/took/yii2-gii-mcp/examples/test-list-tables.php
```

### 6. First Use

[](#6-first-use)

Ask your AI assistant (Firebender, Claude, etc.):

```
"Detect my Yii2 project structure and show me what template type I'm using"
"What environment is currently configured in my Yii2 application?"
"Show me the last 50 error logs from all applications"
"Read warning and error logs from the frontend application from the last 24 hours"
"Search for 'database connection' errors in console logs"
"List all database tables using yii2-gii-mcp inspect-database"
"Show me the structure of the user table using yii2-gii-mcp list-tables user"
"Generate a migration to create the table foo with some random fields"
"Generate a migration to create the table bar with a bar_data text field where each bar has exactly one parent foo"
"Generate ActiveRecord models for the foo and bar tables using yii2-gii-mcp (in /web or prefered in /common if available)"
"Create CRUD operations (in the Backend/BackOffice if available) for the foo table using yii2-gii-mcp"
"Update the controller and CRUD views for foo to support the relation to bar ("inline" update of bar_data/insert new bars)."

```

The AI will use the MCP tools to inspect your database and generate code!

Usage Examples
--------------

[](#usage-examples)

### Database Inspection

[](#database-inspection)

```
You: "What tables are in my database?"
AI: [Uses list-tables tool] "Found 15 tables: users, posts, comments, ..."

You: "Show me the schema for the users table"
AI: [Uses inspect-database] "The users table has columns: id (int), username (varchar), ..."

```

### Model Generation

[](#model-generation)

```
You: "Generate a User model from the users table"
AI: [Uses generate-model with preview] "Here's a preview of the User model..."

You: "Looks good, generate it"
AI: [Writes file] "Created User model at app/models/User.php"

```

### CRUD Scaffolding

[](#crud-scaffolding)

```
You: "I need CRUD operations for the Post model"
AI: [Uses generate-crud] "Generated:
  - PostController.php
  - PostSearch.php
  - views/post/index.php
  - views/post/view.php
  - views/post/create.php
  - views/post/update.php"

```

Available Tools
---------------

[](#available-tools)

### Code Generation & Scaffolding

[](#code-generation--scaffolding)

ToolPurposeSafety`list-tables`List all database tables✅ Read-only`inspect-database`Detailed schema inspection✅ Read-only`generate-model`Generate ActiveRecord models⚠️ Writes files`generate-crud`Generate CRUD operations⚠️ Writes files`generate-controller`Generate controllers⚠️ Writes files`generate-form`Generate form models⚠️ Writes files`generate-module`Generate modules⚠️ Writes files`generate-extension`Generate extensions⚠️ Writes files### Migration Management

[](#migration-management)

ToolPurposeSafety`list-migrations`List migrations with status (applied/pending)✅ Read-only`create-migration`Create new migration files with field definitions⚠️ Writes files`execute-migration`Execute migration operations (up/down/redo/fresh) and preview SQL🔴 Modifies database### Project Analysis

[](#project-analysis)

ToolPurposeSafety`detect-application-structure`Detect project structure, template type, apps, and environments✅ Read-only### Code Analysis & Inspection

[](#code-analysis--inspection)

ToolPurposeSafety`inspect-components`List and analyze controllers, models, views with metadata✅ Read-only### Logging & Debugging

[](#logging--debugging)

ToolPurposeSafety`read-logs`Read and filter logs from files and database (level, category, search)✅ Read-only**Total: 14 production-ready tools**

All generation tools default to **preview mode** for safety. The `execute-migration` tool requires **explicit confirmations** for all operations.

Troubleshooting
---------------

[](#troubleshooting)

### "Tools not available" in AI assistant

[](#tools-not-available-in-ai-assistant)

1. Run diagnostics: `php vendor/took/yii2-gii-mcp/bin/diagnose`
2. Check `config-mcp.php` exists
3. Verify database connection in config
4. Restart your IDE/client completely

### Database connection errors

[](#database-connection-errors)

1. Check database credentials in `config-mcp.php`
2. Ensure database is running
3. Run: `php vendor/took/yii2-gii-mcp/bin/diagnose`

### Firebender doesn't see MCP server

[](#firebender-doesnt-see-mcp-server)

1. Verify `~/.firebender/firebender.json` exists and has correct JSON syntax
2. Completely restart PhpStorm (not just close window)
3. Check logs: Help → Show Log in Files

### Files not generated

[](#files-not-generated)

1. Check write permissions on target directory
2. Ask AI to show preview first
3. Verify Gii module is enabled in config

For more troubleshooting, see the [comprehensive documentation](docs/AI-MEMORY-BANK.md).

Documentation
-------------

[](#documentation)

- **For AI Agents**: [docs/AI-MEMORY-BANK.md](docs/AI-MEMORY-BANK.md) - Complete technical reference
- **Interactive Setup**: Run `php vendor/took/yii2-gii-mcp/bin/interactive-setup`
- **Diagnostics**: Run `php vendor/took/yii2-gii-mcp/bin/diagnose`
- **Examples**: See `examples/` directory for config templates and test scripts
- **Implementation Roadmap**: See `TODO.md` for development plans

Development
-----------

[](#development)

### Running Tests

[](#running-tests)

```
# Run all tests
make test

# Run specific test suite
make test-unit             # Unit tests
make test-functional       # Functional tests

# Generate coverage report
make coverage
```

Or with Composer:

```
composer test
composer test-unit
composer test-functional
```

### Adding New Tools

[](#adding-new-tools)

See [docs/AI-MEMORY-BANK.md](docs/AI-MEMORY-BANK.md) for detailed development guidelines.

Support and Contributing
------------------------

[](#support-and-contributing)

- **Issues**: Use GitHub Issues to report bugs or request features
- **Pull Requests**: Fork the repo and follow PSR-12 coding standards
- **Tests**: Include tests for new tools (we use Codeception)
- **Documentation**: Update the AI memory bank for significant changes

Authors
-------

[](#authors)

- **Author**: Guido Pannenbecker
- **AI Implementation**: Significant portions implemented with AI coding agents (Firebender, Claude)

License
-------

[](#license)

MIT - See LICENSE file for details.

Project Status
--------------

[](#project-status)

**Patch 1.1.1 Released**

Patch 1.1.1 fixed some tests

**Version 1.1.0 Released** 🎉

- ✅ Full MCP protocol implementation (JSON-RPC 2.0 over stdio)
- ✅ 14 production-ready tools (8 Gii generators + 3 migration tools + 3 analysis/inspection tools)
- ✅ Comprehensive test suite (450+ tests, 60% coverage)
- ✅ Interactive setup wizard and diagnostic tools
- ✅ Complete documentation for humans and AI agents
- ✅ Migration management with safety features
- ✅ Project structure detection and analysis
- ✅ Component inspection with metadata extraction
- ✅ Application log reading and filtering
- ✅ Code consolidation (DRY principle applied)

**Next Phase**: Routing inspection, i18n tools, RBAC testing, custom templates

See `TODO.md` for detailed roadmap.

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance81

Actively maintained with recent releases

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

3

Last Release

121d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6e256c19fedd03f48da76a88401b74d4179bf51869515fa2d714304600b4c928?d=identicon)[took](/maintainers/took)

---

Top Contributors

[![took](https://avatars.githubusercontent.com/u/191625?v=4)](https://github.com/took "took (8 commits)")

---

Tags

scaffoldingmcpyii2json-rpcgiicode-generationclaudeanthropicModel Context Protocolai-tools

###  Code Quality

TestsCodeception

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/took-yii2-gii-mcp/health.svg)

```
[![Health](https://phpackages.com/badges/took-yii2-gii-mcp/health.svg)](https://phpackages.com/packages/took-yii2-gii-mcp)
```

###  Alternatives

[vizra/vizra-adk

Vizra Agent Development Kit - A comprehensive Laravel package for building intelligent AI agents.

29026.1k](/packages/vizra-vizra-adk)[yiisoft/yii2-gii

The Gii extension for the Yii framework

21118.4M613](/packages/yiisoft-yii2-gii)[php-mcp/laravel

Laravel SDK for building Model Context Protocol (MCP) servers - Seamlessly integrate MCP tools, resources, and prompts into Laravel applications

47283.1k1](/packages/php-mcp-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)