Skip to content

Commit ad114d3

Browse files
committed
Readme updates
1 parent e6e7e91 commit ad114d3

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
# Filament MCP Server - Laravel Loop
22

3+
> [!IMPORTANT]
4+
> This is a beta version and is not recommended for production use yet.
5+
36
The Laravel Loop Filament MCP Server is an extension for [Laravel Loop](https://github.com/kirschbaum-development/laravel-loop) that exposes your Filament Resources as an MCP server. This allows AI assistants and MCP clients to interact with your Filament Resources for data listing, querying, and (optionally) actions.
47

58
## What It Does
69

7-
- Exposes your Filament Resources as MCP tools
8-
- Allows AI assistants and MCP clients to:
9-
- List available Filament Resources
10-
- Describe resource structure, fields, columns, filters, and relationships
11-
- Query resource data with filters
12-
- (Optionally) Execute resource actions (bulk actions, etc.)
10+
Exposes your Filament Resources as MCP tools. There are 4 tools available:
11+
12+
- `list_filament_resources`: Lists all available Filament Resources to the MCP client.
13+
- `describe_filament_resource`: Describes the structure, fields, columns, filters, and relationships for a given resource to the MCP client.
14+
- `get_filament_resource_data`: Queries data for a resource, with optional filters.
15+
- `execute_filament_resource_action`: Executes a bulk action on a resource (only in ReadWrite mode).
16+
17+
1318

1419
## Installation
1520

@@ -56,10 +61,16 @@ Loop::toolkit(
5661

5762
## Usage
5863

64+
After registering the toolkit, you have to connect Laravel Loop to a MCP client, and the tools will be available.
5965

6066
## Security
61-
Only expose the MCP endpoint to trusted clients. Use authentication middleware (e.g., Sanctum) for HTTP endpoints.
67+
68+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
69+
70+
## Sponsorship
71+
72+
Development of this package is sponsored by Kirschbaum Development Group, a developer driven company focused on problem solving, team building, and community. Learn more [about us](https://kirschbaumdevelopment.com?utm_source=github) or [join us](https://careers.kirschbaumdevelopment.com?utm_source=github)!
6273

6374
## License
6475

65-
MIT
76+
The MIT License (MIT). Please see [License File](LICENSE) for more information.

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "kirschbaum-development/laravel-loop-filament-mcp-server",
2+
"name": "kirschbaum-development/laravel-loop-filament",
33
"description": "Filament MCP Server for Laravel Loop",
44
"type": "library",
55
"license": "MIT",

0 commit comments

Comments
 (0)