# Laravel Restify

Transform Laravel Eloquent models into JSON:API endpoints and MCP servers automatically. Complete Laravel API framework with authentication, filtering, and AI agent integration.

- [Laravel Restify - PHP REST API Framework & JSON API Generator](https://laravel-restify.com/docs.md): Transform Laravel Eloquent models into JSON:API endpoints and MCP servers automatically. Complete Laravel API framework with authentication, filtering, and AI agent integration.

## Getting Started

- [Quick Start](https://laravel-restify.com/docs/getting-started/quickstart.md): Get started with Laravel Restify in minutes. Install via Composer, run the setup command, and serve a full REST API from your Laravel application.

## Authentication

- [Authentication](https://laravel-restify.com/docs/auth/authentication.md): Set up authentication in Laravel Restify using Sanctum — register, login, logout, password reset, and email verification with one artisan command.
- [Authorization](https://laravel-restify.com/docs/auth/authorization.md): Laravel Restify unifies authorization across REST API endpoints and MCP tools using Laravel policies, covering gates, lifecycle, and access control.
- [Profile Management](https://laravel-restify.com/docs/auth/profile.md): Learn how Restify's profile endpoint lets authenticated users retrieve and update their data using UserRepository for full control over exposed fields.

## API Resources

- [Basic Repositories](https://laravel-restify.com/docs/api/repositories-basic.md): Learn how Laravel Restify repositories expose Eloquent models as REST APIs with automatic CRUD endpoints, field definitions, and full control over validation.
- [Repositories](https://laravel-restify.com/docs/api/repositories.md): Learn how Laravel Restify repositories power your REST API and AI agent integrations, with Artisan commands, field definitions, and lifecycle control.
- [Advanced Repositories](https://laravel-restify.com/docs/api/repositories-advanced.md): Master advanced Laravel Restify repository features: query customization, lifecycle hooks, public repositories, custom routes, and performance tuning.
- [Repository Generation](https://laravel-restify.com/docs/api/repository-generation.md): Generate Laravel Restify repositories with smart path detection and automatic relationship scaffolding using the restify:repository Artisan command.
- [Fields](https://laravel-restify.com/docs/api/fields.md): Learn how to declare and customize model attribute fields in Laravel Restify using a fluent API with built-in validation, mutators, and computed values.
- [Relations](https://laravel-restify.com/docs/api/relations.md): Learn how Restify handles Eloquent relationships. Define HasMany, BelongsTo, and other eager fields in the related() method to expose nested API resources.
- [REST Methods](https://laravel-restify.com/docs/api/rest-methods.md): Learn how Laravel Restify's RestController and RestResponse structure help you return consistent, JSON:API-compatible responses across all your API endpoints.
- [Validation Methods](https://laravel-restify.com/docs/api/validation-methods.md): Learn how to use fluent validation methods in Laravel Restify to chain rules like required(), email(), min(), and max() directly on fields for cleaner API code.
- [Actions](https://laravel-restify.com/docs/api/actions.md): Learn how Laravel Restify Actions let you define extra repository operations as invokable classes, improving testability and code maintainability.
- [Getters](https://laravel-restify.com/docs/api/getters.md): Learn how to define and register Getters in Laravel Restify — repository-attached GET endpoints with authorization, show/index scopes, and MCP integration.
- [Serializer](https://laravel-restify.com/docs/api/serializer.md): Learn how Laravel Restify's Serializer and rest() helper return consistent JSON:API-style responses with fluent methods for relations and sorting.

## Search & Filtering

- [Basic Filters](https://laravel-restify.com/docs/search/basic-filters.md): Learn how to use global search and basic filters in Laravel Restify. Define searchable fields, paginate results, and integrate Laravel Scout.
- [Advanced Filters](https://laravel-restify.com/docs/search/advanced-filters.md): Build custom Advanced Filters in Laravel Restify by extending AdvancedFilter — define rules, authorize access, and filter Eloquent queries your way.
- [Sorting](https://laravel-restify.com/docs/search/sorting.md): Learn how to sort API results in Laravel Restify using the $sort property, query parameters, and relation-based sorting for hasOne relationships.

## GraphQL

- [GraphQL Overview](https://laravel-restify.com/docs/graphql/graphql.md): Laravel Restify auto-generates GraphQL schemas and resolvers from your repositories, enabling full CRUD operations via GraphQL using Lighthouse.
- [Schema Generation](https://laravel-restify.com/docs/graphql/graphql-generation.md): Learn how Laravel Restify auto-generates GraphQL schemas, queries, mutations, and resolver classes from your repositories using a single Artisan command.

## MCP Integration

- [MCP Server](https://laravel-restify.com/docs/mcp/mcp.md): Learn how Laravel Restify integrates with the Model Context Protocol to expose your repositories as tools that AI agents can discover and call.
- [MCP Repositories](https://laravel-restify.com/docs/mcp/repositories.md): Learn how Laravel Restify repositories expose data as MCP tools using the HasMcpTools trait, enabling AI agents to query, filter, and sort records efficiently.
- [MCP Fields](https://laravel-restify.com/docs/mcp/fields.md): Learn how Laravel Restify MCP field methods like fieldsForMcpIndex and fieldsForMcpShow optimize data for AI agents, reducing token usage by up to 70%.
- [MCP Getters](https://laravel-restify.com/docs/mcp/getters.md): Learn how to expose Laravel Restify Getters to AI agents via MCP, with validation rules, JSON Schema generation, hideFromMcp(), and security best practices.
- [JSON Schema Converter](https://laravel-restify.com/docs/mcp/json-schema-converter.md): Learn how Restify converts Laravel validation rules into JSON Schema for MCP agents using JsonSchemaFromRulesAction, with wildcard array and type support.
- [MCP Actions](https://laravel-restify.com/docs/mcp/actions.md): Learn how to expose Laravel Restify actions to AI agents via MCP, configure action scopes, generate JSON Schema from validation rules, and control visibility.
- [AI Instructions](https://laravel-restify.com/docs/mcp/ai-instructions.md): Every MCP-enabled repository automatically exposes an AI instructions endpoint: a single, client-agnostic Markdown document that describes the whole repository's tool surface — its CRUD operations,...

## Performance

- [Performance Overview](https://laravel-restify.com/docs/performance/performance.md): Boost Laravel Restify API speed with policy caching, index meta toggling, and repository index caching to handle large datasets efficiently.
- [Optimization Solutions](https://laravel-restify.com/docs/performance/solutions.md): Laravel Restify can auto-suggest AI-powered fixes for exceptions in debug mode by extending RestifyHandler and connecting your OpenAI API key.

## Extensions

- [Boost Package](https://laravel-restify.com/docs/boost/boost.md): Restify Boost is a Laravel Restify extension that adds an MCP server, letting AI agents generate repositories, actions, getters, and query API docs.

## Testing

- [Testing Guide](https://laravel-restify.com/docs/testing/testing.md): Learn how to test Laravel Restify repositories using partialMock to stub actions and assert JSON API responses in your PHPUnit test cases.