Skip to main content

Model Context Protocol (MCP) server for accessing and searching Laravel 12 documentation. Enables AI assistants and tools to query Laravel docs through a standardized interface.

Project description

Laravel Docs MCP Server

GitHub release (latest by date) PyPI Python Version GitHub Workflow Status License 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.

Are you creating or modifying a Laravel app? Hook this MCP up to your AI assistant and immediately get access to:

  • The latest Laravel documentation, for all versions from 6.x
  • Intelligent Laravel package recommendations based on the context from your codebase, and what you're trying to accomplish.

This is like having a very book-smart and up-to-date Laravel dev sit next to you as you code your application.

Update Frequency

This application is written in a way to maximize the value out of GitHub Actions. Every day, it retrieves the latest Laravel documentation for all versions since 6.x (sometimes the old docs get updated too!). If it finds any updates, a new patch release will automatically be generated here and then distributed to both Pypi and GHCR for your consumption. Mmm, delicious.

Installation

Quick Install via Smithery

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

Note: Smithery automatically configures your AI client. Skip to "First Run" below.

Install from PyPI

pip install laravel-docs-mcp

Docker

docker run ghcr.io/brianirish/laravel-docs-mcp:latest

Usage

Smithery Installation

No additional configuration needed - Smithery automatically sets up your AI client.

PyPI Installation

Add this to your AI client's MCP configuration:

{
  "mcpServers": {
    "laravel-docs": {
      "command": "python",
      "args": ["laravel_docs_server.py"]
    }
  }
}

Docker Installation

Add this to your AI client's MCP configuration:

{
  "mcpServers": {
    "laravel-docs": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "ghcr.io/brianirish/laravel-docs-mcp:latest"]
    }
  }
}

Custom Options

For PyPI installations, add options to the args array:

{
  "mcpServers": {
    "laravel-docs": {
      "command": "python",
      "args": [
        "laravel_docs_server.py",
        "--version", "11.x",
        "--log-level", "INFO",
        "--update-docs"
      ]
    }
  }
}

Available Options

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

First Run

The server automatically downloads Laravel documentation on first use. This may take a few moments initially.

Features and Roadmap

Current Features (v0.3.x)

  • Multi-Version Support: Access documentation for Laravel 6.x through latest version simultaneously
  • Future-Proof Version Detection: Automatically detects and supports new Laravel releases (13.x, 14.x, etc.)
  • Daily Documentation Updates: Automatically syncs with Laravel's GitHub repository every day
  • Dynamic Versioning: Automatic version management based on git tags
  • Automated Releases: Patch releases triggered by documentation updates
  • Multiple Deployment Options: PyPI package, Docker images, and Smithery marketplace
  • Package Recommendations: Intelligent suggestions based on specific use cases
  • Implementation Guidance: Detailed information for common Laravel packages
  • Flexible Configuration: Support for multiple Laravel versions
  • Graceful Shutdown: Proper cleanup and signal handling

Upcoming Features

  • 🔧 v0.4.0: Comprehensive testing, performance optimization, enhanced error handling
  • 🔍 v0.5.0: Semantic search, code example extraction, cross-version comparison
  • 📦 v0.6.0: Extended Laravel ecosystem support, community package integration
  • 🎯 v0.7.0: Project analysis, personalized recommendations, migration assistance
  • 🚀 v1.0.0: The definitive Laravel documentation companion

For detailed roadmap information, see ROADMAP.md.

License

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

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

Acknowledgements

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

✅ Certified by MCP Review

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

laravel_docs_mcp-0.3.0.tar.gz (4.0 MB view details)

Uploaded Source

Built Distribution

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

laravel_docs_mcp-0.3.0-py3-none-any.whl (4.4 MB view details)

Uploaded Python 3

File details

Details for the file laravel_docs_mcp-0.3.0.tar.gz.

File metadata

  • Download URL: laravel_docs_mcp-0.3.0.tar.gz
  • Upload date:
  • Size: 4.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for laravel_docs_mcp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 8511e8d1631aa3930378620af10fd05dd8fcaba44c907fe03f54e9cdc7e211df
MD5 bbc01790e20cd6e992c6c7f1a4ca11b2
BLAKE2b-256 71a9365f56db9447aea0687dd3b92fab5509b4cd2990648d328de837ecce6540

See more details on using hashes here.

Provenance

The following attestation bundles were made for laravel_docs_mcp-0.3.0.tar.gz:

Publisher: release.yaml on brianirish/laravel-docs-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file laravel_docs_mcp-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for laravel_docs_mcp-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e932bcb5d8e0d3e2c677b735f5bbec9f68fef0a037d8010e55645d33fc23e24
MD5 e77e578611a5ab4a7470634d029e426d
BLAKE2b-256 f5f7bc8d0d5dfffa9e5486fa72ee09138da1dc62a113088efb33784a8173750d

See more details on using hashes here.

Provenance

The following attestation bundles were made for laravel_docs_mcp-0.3.0-py3-none-any.whl:

Publisher: release.yaml on brianirish/laravel-docs-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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