Skip to main content
Glama
README.md
# 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

```bash
# Clone or navigate to the project directory
cd laravel-ai
npm install
```

### 2. Start MCP Server

```bash
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`):

```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:

```json
{
  "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:

```javascript
// 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

```javascript
// Search for "transaction"
mcp.call_tool('search_docs', { query: 'transaction' })
```

### Get Domain Examples

```javascript
// 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

```bash
npm run dev
```

### Testing

Test the MCP server manually:

```bash
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:

```bash
# Stop current server (Ctrl+C)
npm start
```

---

**Version:** 1.0.0
**Last Updated:** 2026-02-23

TDQS

A3.5/5.0

Scored across 8 tools

Disambiguation5/5

Every tool has a clearly distinct purpose with no ambiguity. The tools target different aspects of documentation retrieval: checklists, design systems, structures, examples, references, templates, specific files, and search. There is no overlap in functionality.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern using snake_case. Each name starts with 'get_' or a similar verb ('read_', 'search_') followed by a descriptive noun, making the set predictable and readable.

Tool Count5/5

With 8 tools, the server is well-scoped for its purpose of providing Laravel documentation and resources. Each tool earns its place by covering a specific aspect of documentation retrieval, avoiding bloat or thinness.

Completeness5/5

The tool surface is complete for the domain of documentation access, covering all key operations: retrieving specific files, searching, getting structured overviews, examples, templates, and references. There are no obvious gaps that would hinder an agent's workflow.

Maintenance

ActivityInactive
ResponsivenessNo issues