Skip to content

Commit 8105bf9

Browse files
committed
introduction
1 parent 673dca4 commit 8105bf9

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# Laravel MCP (Model Context Protocol)
1+
# Laravel MCP
22

3-
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). It aims to be like a USB-C port for AI applications, enabling standardized connections between AI models and various data sources or tools.
4-
5-
This Laravel package helps you build MCP-compliant servers within your Laravel applications. These servers can then expose tools that AI agents can use. It provides a structured way to define servers and their capabilities (tools), accessible via streamed HTTP (web) or STDIO (local artisan commands).
3+
## Introduction
4+
Laravel MCP gives you everything you need to build Laravel-powered MCP servers and let AI talk to your app.
65

76
## Table of Contents
87

@@ -23,17 +22,21 @@ This Laravel package helps you build MCP-compliant servers within your Laravel a
2322
- [Dynamically Adding Methods](#dynamically-adding-methods)
2423
- [What's Not Included (Yet!)](#whats-not-included-yet)
2524

26-
## Setup
25+
## Installation
26+
27+
To get started, install Laravel MCP via the Composer package manager:
2728

28-
### Publishing Routes
29+
```bash
30+
composer require laravel/mcp
31+
```
2932

30-
The package offers an optional route file `routes/ai.php` to define your MCP servers. To publish this file to your application\'s `routes` directory, run the following Artisan command:
33+
Next, you can optionally publish the `routes/ai.php` file to define your MCP servers:
3134

3235
```bash
3336
php artisan vendor:publish --tag=ai-routes
3437
```
3538

36-
The package automatically loads routes defined in this file. Web routes will be prefixed with `/mcp`.
39+
The package will automatically register MCP server defined in this file.
3740

3841
## Creating a Server
3942

0 commit comments

Comments
 (0)