Automatically fetches and updates Laravel documentation from GitHub repository, supporting different Laravel versions and providing version control integration for documentation updates.
Provides access to Laravel documentation, enabling search and retrieval of Laravel docs across different versions. Includes tools for listing documentation files, searching documentation for specific terms, and automatically fetching and updating documentation from Laravel's GitHub repository.
Laravel Docs MCP Server
⚠️ Alpha Software - This project is in early development. Features may not work as expected and breaking changes may occur without notice.
An AI assistant for Laravel developers that provides access to the latest Laravel documentation and intelligent package recommendations through the Model Context Protocol (MCP). This enables AI tools to help you build Laravel applications with up-to-date information and best practices.
Overview
This server enables AI assistants to access Laravel documentation and package recommendations using the Model Context Protocol (MCP). It allows AI tools to:
- Access and search Laravel documentation
- Receive package recommendations based on specific use cases
- Get implementation guidance for popular Laravel packages
- Automatically update documentation from Laravel's GitHub repository
Installation
Quick Install via Smithery
Install from PyPI
Docker
Manual Installation from Source
Prerequisites
- Python 3.12+
uv
package manager (recommended)
Steps
- Clone the repository:
- Set up environment and install dependencies:
Usage
Starting the Server
The server automatically fetches Laravel documentation on first run and can be stopped with Ctrl+C.
Command Line Options
Option | Description |
---|---|
--docs-path PATH | Documentation directory path (default: ./docs) |
--server-name NAME | Server name (default: LaravelDocs) |
--log-level LEVEL | Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL (default: INFO) |
--transport TYPE | Transport method: stdio, websocket, sse (default: stdio) |
--host HOST | Host to bind to (network transport) |
--port PORT | Port to listen on (network transport) |
--version VERSION | Laravel version branch (default: 12.x) |
--update-docs | Update documentation before starting |
--force-update | Force documentation update |
Example with custom options:
Documentation Updater
You can update the documentation separately:
API Reference
Client Example
Available Tools
Documentation Tools
list_docs()
- List all documentation filessearch_docs(query: str)
- Search documentation for specific termsupdate_docs(version: Optional[str], force: bool)
- Update documentationdocs_info()
- Get documentation version information
Package Recommendation Tools
get_package_recommendations(use_case: str)
- Get package recommendations for a use caseget_package_info(package_name: str)
- Get details about a specific packageget_package_categories(category: str)
- List packages in a specific categoryget_features_for_package(package: str)
- Get available features for a package
Resource Access
Documentation files can be accessed as resources using:
Examples:
laravel://routing.md
laravel://authentication.md
Automated Workflows
This project includes several automated GitHub Actions workflows:
Daily Documentation Updates
- Trigger: Every day at midnight UTC (can also be triggered manually)
- Process: Checks for Laravel documentation updates → Creates PR → Auto-merges → Creates patch version tag
- Result: Automatic patch releases when Laravel docs are updated
Release Publishing
- Trigger: When version tags are pushed (e.g.,
v0.1.4
) - Process: Builds packages → Publishes to PyPI → Builds and pushes Docker images to GHCR
- Result: Synchronized releases across PyPI and Docker Hub
Dynamic Versioning
- Version Source: Automatically derived from git tags using
hatch-vcs
- Development Builds: Get unique identifiers (e.g.,
0.1.3.dev1+g75aec71
) - Release Builds: Clean version numbers matching tags (e.g.,
0.1.4
)
Features and Roadmap
Current Features:
- ✅ 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 and transport methods
- ✅ Graceful Shutdown: Proper cleanup and signal handling
Planned Features:
- 🔄 Multi-version support (access documentation for multiple Laravel versions simultaneously)
- 🔍 User project analysis for tailored recommendations
- 🚀 Enhanced search capabilities with semantic matching
- 📊 Usage analytics and insights
- 🔗 Additional Laravel ecosystem integrations
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
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
A Model Context Protocol server that provides AI assistants and language models with access to Laravel 12 documentation, allowing them to list, read, and search through documentation files.
Related MCP Servers
- -securityFlicense-qualityA Model Context Protocol server utilizing Claude AI for generating intelligent queries and offering documentation assistance based on API documentation analysis.Last updated -32TypeScript
- AsecurityAlicenseAqualityA Model Context Protocol server that enables AI assistants like Claude to interact with Outline document services, supporting document searching, reading, creation, editing, and comment management.Last updated -251PythonMIT License
- AsecurityFlicenseAqualityA Model Context Protocol server that enables AI assistants like Claude to access and search Atlassian Confluence content, allowing integration with your organization's knowledge base.Last updated -51,0717TypeScript
- AsecurityAlicenseAqualityA Model Context Protocol server that enables AI assistants to interact with Confluence content, supporting operations like retrieving, searching, creating, and updating pages and spaces.Last updated -93TypeScriptMIT License