Skip to content

Commit a0a4e56

Browse files
committed
docs: update README with table of contents and framework integration details
1 parent fbcecbc commit a0a4e56

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,38 @@ A comprehensive PHP SDK for building [Model Context Protocol (MCP)](https://mode
99
servers. Create production-ready MCP servers in PHP with modern architecture, flexible transport options, and
1010
comprehensive feature support.
1111

12+
## Table of Contents
13+
- [Requirements](#requirements)
14+
- [Installation](#installation)
15+
- [Framework Integration](#framework-integration)
16+
- [Quick Start](#quick-start)
17+
- [Core Concepts](#core-concepts)
18+
- [Transport Options](#transport-options)
19+
- [STDIO Transport](#stdio-transport-recommended-for-cli)
20+
- [HTTP Transport with SSE](#http-transport-with-sse)
21+
- [Streamable HTTP Transport](#streamable-http-transport)
22+
- [Working with Tools](#working-with-tools)
23+
- [Basic Tool Registration](#basic-tool-registration)
24+
- [Advanced Tool with Multiple Content Types](#advanced-tool-with-multiple-content-types)
25+
- [Error Handling in Tools](#error-handling-in-tools)
26+
- [Working with Resources](#working-with-resources)
27+
- [Working with Prompts](#working-with-prompts)
28+
- [HTTP Middleware](#http-middleware)
29+
- [Built-in Middleware](#built-in-middleware)
30+
- [CORS Middleware](#cors-middleware)
31+
- [Authentication Middleware](#authentication-middleware)
32+
- [Custom Middleware](#custom-middleware)
33+
- [Advanced Configuration](#advanced-configuration)
34+
- [Complete Server Setup](#complete-server-setup)
35+
- [Event Store for Resumability](#event-store-for-resumability)
36+
- [Common Patterns](#common-patterns)
37+
- [Handler Factory Pattern](#handler-factory-pattern)
38+
- [Decorator Pattern for Handlers](#decorator-pattern-for-handlers)
39+
- [Ecosystem & Extensions](#ecosystem--extensions)
40+
- [Contributing](#contributing)
41+
- [License](#license)
42+
- [Acknowledgments](#acknowledgments)
43+
1244
> This SDK implements the **MCP 2025-03-26** specification with full backward compatibility support.
1345
1446
## Features
@@ -22,6 +54,22 @@ comprehensive feature support.
2254
- **Extensible Design**: Pluggable components with clear interfaces
2355
- **Production Ready**: Comprehensive logging, error handling, and testing support
2456

57+
### What's NOT Included
58+
59+
This SDK focuses on core MCP functionality and intentionally **does not include**:
60+
61+
- **Resource Discovery**: Automatic scanning and registration of resources from filesystem or annotations
62+
- **Schema Generation**: Automatic generation of JSON schemas from PHP code or docblocks
63+
- **Request Validation**: Built-in validation of incoming requests against defined schemas
64+
- **Framework Integration**: Direct integration with web frameworks (Laravel, Symfony, etc.)
65+
66+
**Why?** These features are better implemented as separate packages or framework-specific bridges that can:
67+
68+
- Provide opinionated conventions for specific use cases
69+
- Integrate deeply with framework ecosystems
70+
- Offer different approaches to schema management
71+
- Maintain focused, single-responsibility packages
72+
2573
## Requirements
2674

2775
- **PHP** >= 8.3 (required for advanced type features and performance)
@@ -33,6 +81,18 @@ comprehensive feature support.
3381
composer require llm/mcp-server
3482
```
3583

84+
### Framework Integration
85+
86+
For enhanced developer experience with automatic discovery and validation:
87+
88+
**Spiral Framework**: Use the [spiral/mcp-server](https://github.com/spiral-packages/mcp-server) bridge
89+
90+
```bash
91+
composer require spiral/mcp-server
92+
```
93+
94+
**Other Frameworks**: Framework-specific bridges are planned. Contributions welcome!
95+
3696
## Quick Start
3797

3898
Here's a minimal working example that demonstrates core functionality:
@@ -782,6 +842,23 @@ composer test # Run all tests
782842

783843
The MIT License (MIT). See [LICENSE](LICENSE) for details.
784844

845+
## Ecosystem & Extensions
846+
847+
### Framework Bridges
848+
849+
**Spiral Framework**: [spiral/mcp-server](https://github.com/spiral-packages/mcp-server)
850+
851+
- Automatic resource discovery via annotations
852+
- JSON schema generation from PHP classes
853+
- Built-in request/response validation
854+
- Dependency injection integration
855+
- Configuration management
856+
857+
### Planned Extensions
858+
859+
- **Laravel Bridge**: Integration with Laravel's service container and validation
860+
- **Symfony Bridge**: Symfony bundle with automatic service discovery
861+
785862
## Acknowledgments
786863

787864
- Built on the [Model Context Protocol](https://modelcontextprotocol.io/) specification

0 commit comments

Comments
 (0)