Skip to main content

A Laravel developer's MCP companion. Get the absolute best advice, recommendations, and up-to-date documentation for the entire Laravel ecosystem.

Project description

Laravel MCP Companion

formerly Laravel Docs MCP Server

GitHub release (latest by date) Python Version GitHub Workflow Status codecov License FOSSA Status Docker Image smithery badge GitHub Stars GitHub Forks

⚠️ BETA SOFTWARE - This project is in early development. Features may not work as expected and breaking changes may occur without notice.

Laravel MCP Companion is a comprehensive documentation aggregator and navigator for the Laravel ecosystem. Rather than generating content, it centralizes and organizes existing high-quality documentation from across the Laravel ecosystem, making it easily discoverable through your AI assistant.

Why Laravel MCP Companion?

Feature Laravel MCP Companion Context7
Instant documentation retrieval (zero latency)
Laravel multi-version support (6.x - latest)
Laravel service docs (Forge, Vapor, Nova, Envoyer)
Curated Laravel package recommendations
Offline documentation access
Pre-processed markdown (saves tokens)
No internet requests during use
Laravel-specific search
Auto-discovery of service docs
General documentation (non-Laravel)

While Context7 excels at general documentation retrieval, Laravel MCP Companion is purpose-built for Laravel developers with faster, offline-capable, Laravel-specific features.

What you get:

  • Multi-version Laravel documentation (6.x through latest) with enhanced search
  • Auto-discovery Laravel services - Forge, Vapor, Envoyer, Nova (117+ sections)
  • Community package documentation - 42,000+ lines from Spatie, Livewire, Inertia, Filament
  • Use case mapping - Describe what you need, get relevant packages instantly
  • Package integration guides - Installation and setup for 50+ curated packages
  • Cross-package compatibility - Learn which packages work well together
  • Unified search across core Laravel docs, services, and packages
  • Smart navigation - find exactly what you need for your use case
  • Future-proof updates - automatically adapts to Laravel service changes

Auto-Discovery & Update Frequency

This application features an intelligent auto-discovery system that automatically finds and indexes Laravel documentation. Every day, it:

  • Auto-discovers new documentation sections across Laravel services (Forge, Vapor, Nova, Envoyer)
  • Retrieves the latest Laravel core documentation for all versions since 6.x
  • Fetches community package documentation (Spatie, Livewire, Inertia, Filament)
  • Adapts automatically to structural changes in documentation websites
  • Generates new patch releases automatically when updates are found

Installation

Quick Install via Smithery

npx -y @smithery/cli install @brianirish/laravel-mcp-companion --client claude

Note: Smithery automatically configures your AI client.

Claude Desktop

  1. Open Claude Desktop Settings

    • Click Claude menu → Settings → Developer → Edit Config
  2. Add to your configuration file:

    {
      "mcpServers": {
        "laravel-mcp-companion": {
          "command": "docker",
          "args": ["run", "--rm", "-i", "ghcr.io/brianirish/laravel-mcp-companion:latest"]
        }
      }
    }
    
  3. Restart Claude Desktop for changes to take effect

Config file locations:

  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Claude Code

Use the claude mcp add command:

# Add with Docker
claude mcp add laravel-mcp-companion docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest

# Or add to project-specific config (for team sharing)
claude mcp add laravel-mcp-companion docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --scope project

The --scope project option creates a .mcp.json file in your project root that can be committed to version control.

Configuration Options

These options can be used with the Docker command. For example:

# Update docs for Laravel 11.x only
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --version 11.x

# Force update all documentation
docker run --rm -i ghcr.io/brianirish/laravel-mcp-companion:latest --force-update
Option Description Default
--version VERSION Laravel version (e.g., "12.x", "11.x") Latest
--docs-path PATH Documentation directory ./docs
--log-level LEVEL DEBUG, INFO, WARNING, ERROR, CRITICAL INFO
--update-docs Update documentation on startup false
--force-update Force documentation update false

Features and Roadmap

Current Features (v0.8.0)

  • Multi-version Laravel docs - All versions from 6.x to latest
  • Auto-discovery engine - Finds new docs across Forge, Vapor, Nova, Envoyer
  • Community package docs - 42,000+ lines from Spatie, Livewire, Inertia, Filament
  • Use case mapping - Describe what you need, get relevant packages
  • Package integration guides - Installation and setup for 50+ packages
  • Cross-package compatibility - Documentation for package combinations
  • Unified search - One search across all documentation sources
  • Daily updates - Automatic sync with latest documentation
  • Battle-tested - Comprehensive test suite ensures reliability

Upcoming Features

  • 📰 v0.9.0: Laravel News, Bootcamp, tutorials, and advanced discovery
  • 🔍 v0.10.0: Ecosystem intelligence and real-time updates
  • 🚀 v1.0.0: The complete Laravel documentation navigator

For detailed roadmap information, see ROADMAP.md.

License

This project is licensed under the MIT License - see the LICENSE file for details.

FOSSA Status

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

Acknowledgements

  • Laravel for their excellent documentation
  • Laravel package authors for their contributions to the ecosystem

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_laravel_mcp_companion-0.7.22.tar.gz (61.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file iflow_mcp_laravel_mcp_companion-0.7.22.tar.gz.

File metadata

  • Download URL: iflow_mcp_laravel_mcp_companion-0.7.22.tar.gz
  • Upload date:
  • Size: 61.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_laravel_mcp_companion-0.7.22.tar.gz
Algorithm Hash digest
SHA256 69b327a56498bceffd4a9e3c90b51bbe49e75559e5f78f7493dfb582c4f7314c
MD5 da5397c9d9504b3044b075ba4807bfb4
BLAKE2b-256 3ca06f5185d59eced46aa6b17ad4e2749901cdeba89a3c82ddcab52c1dbbd831

See more details on using hashes here.

File details

Details for the file iflow_mcp_laravel_mcp_companion-0.7.22-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_laravel_mcp_companion-0.7.22-py3-none-any.whl
  • Upload date:
  • Size: 56.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_laravel_mcp_companion-0.7.22-py3-none-any.whl
Algorithm Hash digest
SHA256 06f47d7c846f0836837bd2731e6d05b3abc53a2079cb44a235ddef870fd7876c
MD5 4a40dac524e97d3653c5fcf0ae8aeb95
BLAKE2b-256 9d3af88450a95d2154d6d9237588051ae6bd367b1a0f023f4063a3ac949813f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page