Build APIs for
Humans & AI
Simultaneously

## Install Laravel Restify in my Laravel project

Please help me install and set up Laravel Restify, a package that transforms Laravel Eloquent models into JSON:API endpoints and MCP servers for AI agents.

### Step 1: Install the package

Run this command in your terminal:

```shell
composer require binaryk/laravel-restify
```

### Step 2: Run the setup command

After installation, scaffold the API structure:

```shell
php artisan restify:setup
```

This command will:
- Publish the `config/restify.php` configuration file
- Create `providers/RestifyServiceProvider` and register it
- Create the `app/Restify` directory for repositories
- Generate an abstract `app/Restify/Repository.php` base class
- Scaffold `app/Restify/UserRepository` for immediate use
- Create `routes/ai.php` with commented MCP server configuration

### Step 3: Run migrations

Complete the setup by running migrations:

```shell
php artisan migrate
```

### Step 4: Test the API

Your API is now ready! Test it with:

```bash
GET /api/restify/users?perPage=10&page=1
```

### Step 5 (Optional): Enable MCP Server for AI Agents

To make your API accessible to AI agents like Claude Desktop:

1. Add the MCP server to your `config/ai.php` file:

```php
use Binaryk\LaravelRestify\MCP\RestifyServer;
use Laravel\Mcp\Facades\Mcp;

Mcp::web('restify', RestifyServer::class)
    ->middleware(['auth:sanctum'])
    ->name('mcp.restify');
```

2. Enable MCP tools in your repositories by adding the `HasMcpTools` trait:

```php
use Binaryk\LaravelRestify\MCP\Concerns\HasMcpTools;

#[Model(User::class)]
class UserRepository extends Repository
{
    use HasMcpTools; // Enables MCP tools for AI agents

    public function fields(RestifyRequest $request): array
    {
        return [
            field('name')->required(),
            field('email')->required(),
        ];
    }
}
```

### Next Steps

After installation, please help me:
- Understand what was created during setup
- Learn how to create my first repository
- Test the API endpoints
- Optionally configure authentication with Sanctum

For more information, visit the Laravel Restify documentation at https://restify.binarcode.com