README.md
Provides AI assistants with direct access to Laravel documentation and rules.
Laravel AI - MCP Server
MCP (Model Context Protocol) server for providing Laravel AI documentation to Claude Code and other AI assistants.
š Quick Start
1. Install Dependencies
# Clone or navigate to the project directory
cd laravel-ai
npm install
2. Start MCP Server
npm start
Documentation is expected to be in: ./docs (relative to project root)
āļø Claude Code Configuration
Add to your Claude Code settings (~/.config/claude-code/config.json):
{
"mcpServers": {
"laravel-ai": {
"command": "node",
"args": ["path/to/laravel-ai/index.js"]
}
}
}
Alternative: With Custom Docs Path
If your documentation is in a different location:
{
"mcpServers": {
"laravel-ai": {
"command": "node",
"args": ["path/to/laravel-ai/index.js"],
"env": {
"DOCS_PATH": "/path/to/your/docs"
}
}
}
}
š ļø Available Tools
| Tool | Description |
|---|---|
get_doc_structure |
Get all documentation files structure |
read_doc |
Read a specific documentation file |
search_docs |
Search across all documentation |
get_quick_reference |
Get all coding rules (quick-reference.md) |
get_templates |
Get CRUD templates (specific or all) |
get_checklist |
Get validation checklist (specific layer or all) |
get_domain_examples |
Get domain-specific examples |
get_design_system |
Get design system documentation |
š Documentation Structure
laravel-ai/
āāā docs/ # Documentation folder
ā āāā ai/
ā ā āāā quick-reference.md # All coding rules
ā ā āāā templates.md # Implementation templates
ā ā āāā checklist.md # Validation checklist
ā āāā domains/
ā ā āāā ecommerce/ # E-commerce examples
ā ā āāā hr/ # HR examples
ā ā āāā tourism/ # Tourism examples
ā āāā patterns/ # Pattern documentation
ā āāā design-system.md # Design system (configurable)
āāā index.js # MCP server
āāā package.json # Dependencies
āāā README.md # This file
š” Usage Examples
For AI Assistant
When user says "pelajari docs", AI should:
// 1. Get quick reference
mcp.call_tool('get_quick_reference')
// 2. Get templates
mcp.call_tool('get_templates', { template_type: 'all' })
// 3. Get checklist
mcp.call_tool('get_checklist', { layer: 'all' })
// 4. Confirm ready
Search Documentation
// Search for "transaction"
mcp.call_tool('search_docs', { query: 'transaction' })
Get Domain Examples
// Get e-commerce examples
mcp.call_tool('get_domain_examples', { domain: 'ecommerce' })
// Get all domains overview
mcp.call_tool('get_domain_examples', { domain: 'all' })
š§ Development
Watch Mode
npm run dev
Testing
Test the MCP server manually:
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node index.js
š Notes
- This server uses stdio transport for communication
- All documentation is read from the file system
- No caching - always reads latest documentation
- Supports incremental updates to documentation
š Updates
When documentation is updated, just restart the MCP server:
# Stop current server (Ctrl+C)
npm start
Version: 1.0.0 Last Updated: 2026-02-23
Tools (8)
get_doc_structureGet all documentation files structureread_docRead a specific documentation filesearch_docsSearch across all documentationget_quick_referenceGet all coding rules (quick-reference.md)get_templatesGet CRUD templates (specific or all)get_checklistGet validation checklist (specific layer or all)get_domain_examplesGet domain-specific examplesget_design_systemGet design system documentationEnvironment Variables
DOCS_PATHCustom path to the documentation directoryConfiguration
claude_desktop_config.json
{"mcpServers": {"laravel-ai": {"command": "node", "args": ["path/to/laravel-ai/index.js"]}}}Try it
āSearch the documentation for how to handle database transactions.
āGet the coding rules for our project from the quick reference.
āShow me the CRUD templates available for our Laravel project.
āRetrieve the e-commerce domain examples to help with my current feature.
āGet the validation checklist for the service layer.