Laravel Docs MCP

🚀 Laravel Docs MCP Server

A Model Context Protocol (MCP) server that provides access to Laravel documentation and package recommendations for AI assistants and language models.

🚀 Quick Start

This server enables AI tools to access Laravel documentation and package recommendations via the Model Context Protocol (MCP). It allows AI tools to:

• Access and search Laravel documentation.
• Receive package recommendations for specific use cases.
• Obtain implementation guidance for popular Laravel packages.
• Automatically update documentation from Laravel's GitHub repository.

✨ Features

• Access to Laravel Docs: Allows AI tools to search through Laravel documentation.
• Package Recommendations: Provides package suggestions for specific use - cases.
• Implementation Guidance: Offers guidance on implementing popular Laravel packages.
• Automatic Updates: Automatically fetches the latest Laravel documentation from GitHub.

📦 Installation

Quick Install via Smithery

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

Manual Installation

Prerequisites

• Python 3.12+
• uv package manager (recommended)

Steps

1. Clone the repository:

   git clone https://github.com/yourusername/laravel-docs-mcp.git
   cd laravel-docs-mcp
   

2. Set up the environment and install dependencies:

   # Create and activate a virtual environment
   uv venv
   source .venv/bin/activate  # Linux/macOS
   # Or
   .venv\Scripts\activate     # Windows
   
   # Install dependencies
   uv pip install .
   

💻 Usage Examples

Starting the Server

python laravel_docs_server.py

The server automatically fetches Laravel documentation on the first run. You can stop it using Ctrl+C.

Command - Line Options

Example with custom options:

python laravel_docs_server.py --docs-path /path/to/docs --version 11.x --update-docs --transport websocket --host localhost --port 8000

Documentation Updater

You can update the documentation separately:

# Update documentation
python docs_updater.py --target-dir ./docs --version 12.x

# Check if an update is needed
python docs_updater.py --check-only

# Force update
python docs_updater.py --force

Basic Usage

class MyClient:
    def process_document(self, content):
        # Process document content here
        pass

if __name__ == "__main__":
    client = MyClient()
    server.start(client)

Advanced Usage

import server

server = Server(host="localhost", port=8000)
server.start()

📚 Documentation

API Reference

Client Example

class MyClient:
    def process_document(self, content):
        # Process document content here
        pass

if __name__ == "__main__":
    client = MyClient()
    server.start(client)

Server Class

import server

server = Server(host="localhost", port=8000)
server.start()

📄 License

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

🔗 Contribution

Contributions are welcome! Please refer to CONTRIBUTING.md for guidelines.