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
⚠️ 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file laravel_docs_mcp-0.3.1.tar.gz.
File metadata
- Download URL: laravel_docs_mcp-0.3.1.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
edb57bbc718a4441e0b9b1a0f8eef2a872b725001593577547850bdcd0318584
|
|
| MD5 |
c6b019eee982da629129f7dbc73108cf
|
|
| BLAKE2b-256 |
18c29f3731d6d3af77f9a69e9af633b3eb5953858aa1278b0fbf920274f6d2c4
|
Provenance
The following attestation bundles were made for laravel_docs_mcp-0.3.1.tar.gz:
Publisher:
release.yaml on brianirish/laravel-docs-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
laravel_docs_mcp-0.3.1.tar.gz -
Subject digest:
edb57bbc718a4441e0b9b1a0f8eef2a872b725001593577547850bdcd0318584 - Sigstore transparency entry: 247166189
- Sigstore integration time:
-
Permalink:
brianirish/laravel-docs-mcp@523854a5be6b280b257e872c6398b18389da8d64 -
Branch / Tag:
refs/tags/v0.3.1 - Owner: https://github.com/brianirish
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@523854a5be6b280b257e872c6398b18389da8d64 -
Trigger Event:
push
-
Statement type:
File details
Details for the file laravel_docs_mcp-0.3.1-py3-none-any.whl.
File metadata
- Download URL: laravel_docs_mcp-0.3.1-py3-none-any.whl
- Upload date:
- Size: 4.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3cd6d9f4310b89afde5e75a184132cbf0e1a84a3dd60d5517d77e5eec71281da
|
|
| MD5 |
ea91ed31ff581d40b80236482520a5e2
|
|
| BLAKE2b-256 |
b8eb3312ec414082551d656cd8170b98b49f000744d9f8e2c73ce8f205ceec9f
|
Provenance
The following attestation bundles were made for laravel_docs_mcp-0.3.1-py3-none-any.whl:
Publisher:
release.yaml on brianirish/laravel-docs-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
laravel_docs_mcp-0.3.1-py3-none-any.whl -
Subject digest:
3cd6d9f4310b89afde5e75a184132cbf0e1a84a3dd60d5517d77e5eec71281da - Sigstore transparency entry: 247166217
- Sigstore integration time:
-
Permalink:
brianirish/laravel-docs-mcp@523854a5be6b280b257e872c6398b18389da8d64 -
Branch / Tag:
refs/tags/v0.3.1 - Owner: https://github.com/brianirish
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@523854a5be6b280b257e872c6398b18389da8d64 -
Trigger Event:
push
-
Statement type: