Unified Laravel API Layer for Humans and AI

1<p align="center"><img src="/docs-v2/static/logo.png"></p>
2 
3<p align="center">
4    <a href="https://github.com/BinarCode/laravel-restify/actions"><img src="https://github.com/BinarCode/laravel-restify/actions/workflows/tests.yml/badge.svg" alt="Build Status"></a>
5    <a href="https://packagist.org/packages/binaryk/laravel-restify"><img src="https://poser.pugx.org/binaryk/laravel-restify/d/total.svg" alt="Total Downloads"></a>
6    <a href="https://packagist.org/packages/binaryk/laravel-restify"><img src="https://poser.pugx.org/binaryk/laravel-restify/v/stable.svg" alt="Latest Stable Version"></a>
7    <a href="https://packagist.org/packages/binaryk/laravel-restify"><img src="https://poser.pugx.org/binaryk/laravel-restify/license.svg" alt="License"></a>
8</p>
9 
10# Unified Laravel API Layer for Humans and AI
11 
12**One Codebase. REST for Humans, MCP for AI Agents.**
13 
14Laravel Restify turns your Eloquent models into both JSON:API endpoints and MCP servers -- automatically. Build once, and instantly serve APIs that work seamlessly for developers, apps, and AI agents.
15 
16## 🚀 The Power of One Codebase
17 
18Traditional API development requires separate implementations for different consumers. Laravel Restify changes that:
19 
20- **👥 Humans** get full-featured JSON:API endpoints
21- **🤖 AI Agents** get structured MCP (Model Context Protocol) servers
22- **🔒 Same Rules** - All authentication, authorization, and policies apply to both
23- **📝 One Definition** - Write your repository once, serve everywhere
24 
25## Key Features
26 
27- **JSON:API Endpoints** - Full [JSON:API](https://jsonapi.org) specification compliance
28- **MCP Server Generation** - Automatic AI agent interfaces with tool definitions
29- **Unified Authorization** - Laravel policies protect both human and AI access
30- **Search & Filtering** - Powerful query capabilities for all consumers
31- **Authentication** - Laravel Sanctum integration for secure access
32- **GraphQL Support** - Auto-generated GraphQL schemas
33- **Field Validation** - Consistent validation rules across all interfaces
34 
35## Installation
36 
37```bash
38composer require binaryk/laravel-restify
39```
40 
41## Quick Start
42 
43**1. Setup the package:**
44```bash
45php artisan restify:setup
46```
47 
48**2. Create your first repository:**
49```bash
50php artisan restify:repository PostRepository --all
51```
52 
53**3. Enable MCP for AI agents (optional):**
54 
55Add to your `config/ai.php`:
56```php
57use Binaryk\LaravelRestify\MCP\RestifyServer;
58use Laravel\Mcp\Facades\Mcp;
59 
60Mcp::web('restify', RestifyServer::class)
61    ->middleware(['auth:sanctum'])
62    ->name('mcp.restify');
63```
64 
65**That's it!** Your API now serves both:
66 
67**For Humans (JSON:API):**
68```bash
69GET /api/restify/posts
70POST /api/restify/posts
71PUT /api/restify/posts/1
72DELETE /api/restify/posts/1
73```
74 
75**For AI Agents (MCP):**
76```bash
77GET /mcp/restify  # Tool definitions and capabilities
78```
79 
80## Example Repository
81 
82```php
83use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
84use Binaryk\LaravelRestify\Repositories\Repository;
85use Binaryk\LaravelRestify\Attributes\Model;
86 
87#[Model(Post::class)]
88class PostRepository extends Repository
89{
90    public function fields(RestifyRequest $request): array
91    {
92        return [
93            field('title')->rules('required', 'string', 'max:255'),
94            textarea('content')->rules('required'),
95            field('author')->readonly(),
96            datetime('published_at')->nullable(),
97        ];
98    }
99}
100```
101 
102This single definition automatically provides:
103- ✅ JSON:API CRUD endpoints with validation
104- ✅ MCP tools for AI agents with the same validation
105- ✅ Authorization policies applied to both interfaces
106- ✅ Search and filtering capabilities for all consumers
107 
108## One Codebase, Two Outputs
109 
110Here's what you get from one repository definition:
111 
112### For Humans (JSON:API Response)
113```bash
114GET /api/restify/posts
115```
116 
117```json
118{
119  "data": [
120    {
121      "id": "1",
122      "type": "posts",
123      "attributes": {
124        "title": "Laravel Restify Guide",
125        "content": "Build APIs fast...",
126        "published_at": "2024-01-15"
127      }
128    }
129  ],
130  "links": {
131    "self": "/api/restify/posts",
132    "next": "/api/restify/posts?page=2"
133  }
134}
135```
136 
137### For AI Agents (MCP Tool Definition)
138```bash
139GET /mcp/restify  # Tool definitions for AI agents
140```
141 
142```json
143{
144  "tools": [
145    {
146      "name": "posts-index-tool",
147      "description": "Retrieve a paginated list of Post records from the posts repository with filtering, sorting, and search capabilities.",
148      "inputSchema": {
149        "type": "object",
150        "properties": {
151          "page": {
152            "type": "number",
153            "description": "Page number for pagination"
154          },
155          "perPage": {
156            "type": "number", 
157            "description": "Number of posts per page"
158          },
159          "search": {
160            "type": "string",
161            "description": "Search term to filter posts by title or content"
162          },
163          "sort": {
164            "type": "string",
165            "description": "Sorting criteria (e.g., sort=title or sort=-published_at for descending)"
166          },
167          "title": {
168            "type": "string",
169            "description": "Filter by exact match for title (e.g., title=Laravel). Accepts negation with -title=value"
170          },
171          "published_at": {
172            "type": "string",
173            "description": "Filter by publication date (e.g., published_at=2024-01-15)"
174          }
175        }
176      }
177    }
178  ]
179}
180```
181 
182**All generated from this simple repository:**
183```php
184#[Model(Post::class)]
185class PostRepository extends Repository
186{
187    use HasMcpTools;
188    
189    public function fields(RestifyRequest $request): array
190    {
191        return [
192            field('title')->required()->matchable(),
193            field('content'),
194            field('published_at')->rules('date')->matchable(),
195        ];
196    }
197}
198```
199 
200## Restify Boost
201 
202**Laravel Restify Boost** is a development companion that provides MCP server capabilities to help you build Restify APIs faster with AI assistance.
203 
204**Repository:** [laravel-restify-boost](https://github.com/BinarCode/laravel-restify-boost)
205 
206**Features:**
207- Documentation access for AI agents
208- Repository and action generation assistance
209- Code examples and best practices
210- Integration with Claude Desktop and other AI tools
211 
212**Installation:**
213```bash
214composer require --dev binarcode/laravel-restify-boost
215```
216 
217## Templates
218 
219Need a production-ready starting point? Check out [Restify Templates](https://restifytemplates.com) for complete API starter kits with authentication, permissions, and team management.
220 
221## Resources
222 
223- **[Documentation](https://laravel-restify.com)** - Complete guides and API reference
224- **[Demo Repository](https://github.com/BinarCode/restify-demo)** - Working example
225- **[Video Course](https://www.binarcode.com/learn/restify)** - Visual learning resource
226 
227## Testing
228 
229```bash
230composer test
231```
232 
233## Contributing
234 
235Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
236 
237## Security
238 
239If you discover any security related issues, please email eduard.lupacescu@binarcode.com instead of using the issue tracker.
240 
241## Credits
242 
243- [Eduard Lupacescu](https://twitter.com/LupacescuEuard)
244- [Koen Koenster](https://github.com/Koenster)
245- [All Contributors](../../contributors)
246 
247## License
248 
249The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
250