* [Docs] Render guides with Zensical, deploy via GitHub Pages actions phpDocumentor's guide renderer copies the markdown through mostly verbatim: relative links between pages keep pointing at `*.md` targets that do not exist in the built site, and nothing validates them, so the published guides are full of dead links. Zensical (the Material for MkDocs team's successor to MkDocs) resolves internal links against the page tree and fails the build on a broken one. `zensical build --strict` already found four dead links on the first run — three repo-relative links escaping docs/ (fixed to point at GitHub) and one wrong in-page anchor. phpDocumentor stays on for the class-level API reference only; `make docs` builds the guides into site/ and mounts the reference at site/api/, so its two header links back to the guides now target the site root. Deployment moves from pushing a gh-pages branch to the official GitHub Pages actions, and from release-only to every push on main, with pull requests building (but not deploying) so a broken link fails review instead of the site. NOTE: this needs the repository's Pages source switched to "GitHub Actions" (Settings -> Pages) once. * [Docs] Adopt the Python SDK's documentation look and feel The docs site now uses the same theme configuration as https://py.sdk.modelcontextprotocol.io/ so the language SDKs read as one set of docs: the MCP mark as logo and favicon, Inter/JetBrains Mono, the black/slate palette with a three-way (system/light/dark) toggle, instant navigation, code copy/annotate, and a right-hand table of contents. The markdown extension set is widened to the same list (tabbed blocks, task lists, footnotes, emoji/icons, mermaid fences), which the content restructure builds on. Styling is otherwise stock: no custom stylesheet, and Zensical's own `modern` theme variant, pinned explicitly rather than left to the default. The one departure is code highlighting, which is broken out of the box here: Pygments only highlights PHP after a `<?php` tag, so the guides — whose code blocks are almost all fragments — rendered as flat plain text. The `php` lexer is extended with `startinline`, and complete-file blocks use a `php-file` lexer that keeps the literal open tag highlighted. * [Docs] Restructure the guides into task-oriented sections The guides were ten flat pages, each opening with a hand-maintained table of contents and each mixing several audiences: `mcp-elements.md` covered tools, prompts, schema generation and handler-side logging, `transports.md` covered both transports plus framework integration, and `server-builder.md` covered configuration, sessions and custom message handlers. They are now split along the same lines as the Python SDK's documentation (https://py.sdk.modelcontextprotocol.io/), one topic per page: Get started installation, first server, the Inspector Servers tools, resources, resource templates, prompts, completions, schema generation, registration Inside your handler the ClientGateway, logging Running your server builder, STDIO, HTTP, framework integration, sessions, authorization Clients connecting, transports, capabilities, server-initiated requests, error handling Advanced events, protocol extensions, custom message handlers Prose is carried over as-is apart from the seams; what is new is the landing page and one index page per section, which say what the section is for and where to go next, so no page is a dead end. The per-page "Table of Contents" lists are gone — the theme renders one from the headings — and GitHub's `> [!IMPORTANT]` blockquotes became admonitions, which Zensical renders as callouts rather than plain quotes. Every code sample and factual claim was then checked against src/ and the runnable examples, which turned up long-standing errors in the carried-over prose. Samples that could not run: a prompt using a `system` role (MCP has only user/assistant), `Mcp\Schema\PromptMessage` (it is under `Schema\Content`) constructed with an array instead of a single content object, `Mcp\Capability\Prompt\Completion\ProviderInterface` (it is `Mcp\Capability\Completion\ProviderInterface`), `new EmbeddedResource(type:, resource: [...])` (neither parameter exists), a `: resource` return type (not a PHP type), `#[McpResource]` with a `{path}` variable (that is a template), a stray quote in the builder example, a `middlewares:` argument (it is `middleware:`), and `getRequest()->getAttribute()` in the OAuth guide (no such method — the values arrive on the request meta). Claims corrected: sampling's `system_prompt` option (it is `systemPrompt`), `SampleMessage` (it is `SamplingMessage`), `Notification` called an interface (abstract class), "parameter order matters" for URI templates (bound by name), full RFC 6570 support (only simple `{var}`), the tool description fallback chain, `void` returning empty content, a non-zero STDIO exit code, `ErrorEvent` being null for parse errors, handlers being "prepended", `Psr16StoreSession`, and PSR-3 log context being sent to the client (it is dropped). Sixteen `examples/` paths were missing their `server/` segment. README, the OAuth ADR and one source comment now point at the published site instead of at markdown files that moved. * [Docs] Run the docs workflow unfiltered, keep README links relative The `paths:` filters were mostly noise: `src/**` had to be in the list for the phpDocumentor build, which meant the workflow ran on nearly every PR anyway. They also missed two real inputs — `.phpdoc/template/**` and `composer.lock` — so a template tweak or a phpDocumentor bump could change the rendered site without triggering a build. README links go back to relative repo paths. The README is not part of the Zensical site (`docs_dir` is `docs/`), so those links are only ever resolved by GitHub and Packagist, where absolute URLs break in-repo navigation for no gain. The site pointer and the generated API reference stay absolute. * [Docs] Adopt the doc changes that landed on main into the new structure Twelve commits landed while the restructure was open, seven of them touching the flat guides this branch replaces. Renames merged on their own; the three files that were split apart needed their new sections placed by hand: - Connection retries, protocol version negotiation, sampling with tools and roots from `client.md` into `client/connecting.md` and `client/server-requests.md` - `ResourceLink` and structured output from `mcp-elements.md` into `servers/tools.md` - Protocol version negotiation from `server-builder.md` into `run/server-builder.md` The `setMaxRetries()` note claiming the value is never acted on is gone — #413 implemented it. Callouts became admonitions and cross-links were repointed at the new paths, as everywhere else in this branch. * [Docs] Document the elicitation and roots client examples Both were missing from the examples guide: the elicitation client predates this branch, the roots client arrived with #395. * [Docs] Fold the 2026-07-28 lifecycle into the new structure Main's stateless-lifecycle.md becomes a docs/lifecycle/ section, and the pages main touched — deprecations, the middleware split, the client's modern era — land where the restructure moved them. * [Docs] Link the Inspector to its documentation, not its repo * [Docs] Distribute the 2026-07-28 material into the task sections The Python and TypeScript SDKs file each feature where the task lives and keep only an era comparison on its own page. Follow them: input-required moves next to the other handler concerns, caching, subscriptions and era routing to "Running your server", and one Protocol versions page carries the rest. * [Docs] Move protocol version negotiation onto the Protocol versions page The builder page keeps the setProtocolVersion() knob and links out; how a revision is agreed now sits beside the era it belongs to. * [Docs] Slim the README to a funnel, turn Examples into an index * [Docs] Fix the code samples and API listings flagged by the audit * [Docs] Link the negotiation spec section at latest, not draft
202 lines
5.6 KiB
Markdown
202 lines
5.6 KiB
Markdown
# Framework integration
|
|
|
|
The HTTP transport is a PSR-7 request handler, not a web server. This page
|
|
covers how it fits into an application you already have.
|
|
|
|
## Architecture
|
|
|
|
The HTTP transport doesn't run its own web server. Instead, it processes PSR-7 requests and returns PSR-7 responses that
|
|
your application can handle however it needs to:
|
|
|
|
```
|
|
Your Web App → PSR-7 Request → StreamableHttpTransport → PSR-7 Response → Your Web App
|
|
```
|
|
|
|
This design allows integration with any PHP framework or application that supports PSR-7.
|
|
|
|
## Basic Usage (Standalone)
|
|
|
|
Here's a simplified example using PSR-17 discovery and Laminas emitter:
|
|
|
|
```php
|
|
use Http\Discovery\Psr17Factory;
|
|
use Mcp\Server;
|
|
use Mcp\Server\Transport\StreamableHttpTransport;
|
|
use Mcp\Server\Session\FileSessionStore;
|
|
use Laminas\HttpHandlerRunner\Emitter\SapiEmitter;
|
|
|
|
$psr17Factory = new Psr17Factory();
|
|
$request = $psr17Factory->createServerRequestFromGlobals();
|
|
|
|
$server = Server::builder()
|
|
->setServerInfo('HTTP Server', '1.0.0')
|
|
->setDiscovery(__DIR__, ['.'], excludeDirs: ['vendor'])
|
|
->setSession(new FileSessionStore(__DIR__ . '/sessions')) // HTTP needs persistent sessions
|
|
->build();
|
|
|
|
$transport = new StreamableHttpTransport($request);
|
|
|
|
$response = $server->run($transport);
|
|
|
|
(new SapiEmitter())->emit($response);
|
|
```
|
|
|
|
## Framework Integration
|
|
|
|
### Symfony Integration
|
|
|
|
First install the required PSR libraries:
|
|
|
|
```bash
|
|
composer require symfony/psr-http-message-bridge nyholm/psr7
|
|
```
|
|
|
|
Then create a controller that uses Symfony's PSR-7 bridge:
|
|
|
|
> **Note**: This example assumes your MCP `Server` instance is configured in Symfony's service container.
|
|
|
|
```php
|
|
// In a Symfony controller
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
use Symfony\Component\HttpFoundation\Response;
|
|
use Symfony\Component\Routing\Attribute\Route;
|
|
use Symfony\Bridge\PsrHttpMessage\Factory\PsrHttpFactory;
|
|
use Symfony\Bridge\PsrHttpMessage\Factory\HttpFoundationFactory;
|
|
use Mcp\Server;
|
|
use Mcp\Server\Transport\StreamableHttpTransport;
|
|
|
|
class McpController
|
|
{
|
|
#[Route('/mcp', name: 'mcp_endpoint')]
|
|
public function handle(Request $request, Server $server): Response
|
|
{
|
|
// Convert Symfony request to PSR-7 (PSR-17 factories auto-discovered)
|
|
$psrHttpFactory = new PsrHttpFactory();
|
|
$httpFoundationFactory = new HttpFoundationFactory();
|
|
$psrRequest = $psrHttpFactory->createRequest($request);
|
|
|
|
// Process with MCP (factories auto-discovered)
|
|
$transport = new StreamableHttpTransport($psrRequest);
|
|
$psrResponse = $server->run($transport);
|
|
|
|
// Convert PSR-7 response back to Symfony
|
|
return $httpFoundationFactory->createResponse($psrResponse);
|
|
}
|
|
}
|
|
```
|
|
|
|
### Laravel Integration
|
|
|
|
First install the required PSR libraries:
|
|
|
|
```bash
|
|
composer require symfony/psr-http-message-bridge nyholm/psr7
|
|
```
|
|
|
|
Then create a controller that type-hints `ServerRequestInterface`:
|
|
|
|
> **Note**: This example assumes your MCP `Server` instance is constructed and bound in a Laravel service provider for dependency injection.
|
|
|
|
```php
|
|
// In a Laravel controller
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
use Psr\Http\Message\ResponseInterface;
|
|
use Mcp\Server;
|
|
use Mcp\Server\Transport\StreamableHttpTransport;
|
|
|
|
class McpController
|
|
{
|
|
public function handle(ServerRequestInterface $request, Server $server): ResponseInterface
|
|
{
|
|
// Create the MCP HTTP transport
|
|
$transport = new StreamableHttpTransport($request);
|
|
|
|
// Process MCP request and return PSR-7 response
|
|
// Laravel automatically handles PSR-7 responses
|
|
return $server->run($transport);
|
|
}
|
|
}
|
|
|
|
// Route registration
|
|
Route::any('/mcp', [McpController::class, 'handle']);
|
|
```
|
|
|
|
### Slim Framework Integration
|
|
|
|
Slim Framework works natively with PSR-7.
|
|
|
|
Create a route handler using Slim's built-in factories and container:
|
|
|
|
```php
|
|
use Slim\Factory\AppFactory;
|
|
use Mcp\Server;
|
|
use Mcp\Server\Transport\StreamableHttpTransport;
|
|
|
|
$app = AppFactory::create();
|
|
|
|
$app->any('/mcp', function ($request, $response) {
|
|
$server = Server::builder()
|
|
->setServerInfo('My MCP Server', '1.0.0')
|
|
->setDiscovery(__DIR__, ['.'], excludeDirs: ['vendor'])
|
|
->build();
|
|
|
|
$transport = new StreamableHttpTransport($request);
|
|
|
|
return $server->run($transport);
|
|
});
|
|
```
|
|
|
|
## HTTP Method Handling
|
|
|
|
The transport handles all HTTP methods automatically:
|
|
|
|
- **POST**: Send MCP requests
|
|
- **GET**: Not implemented (returns 405)
|
|
- **DELETE**: End session
|
|
- **OPTIONS**: CORS preflight
|
|
|
|
You should route **all methods** to your MCP endpoint, not just POST.
|
|
|
|
## Session Management
|
|
|
|
HTTP transport requires persistent sessions since PHP doesn't maintain state between requests. Unlike STDIO transport
|
|
where in-memory sessions work fine, HTTP transport needs a persistent session store:
|
|
|
|
```php
|
|
use Mcp\Server\Session\FileSessionStore;
|
|
|
|
// ✅ Good for HTTP
|
|
$server = Server::builder()
|
|
->setSession(new FileSessionStore(__DIR__ . '/sessions'))
|
|
->build();
|
|
|
|
// ❌ Not recommended for HTTP (sessions lost between requests)
|
|
$server = Server::builder()
|
|
->setSession(new InMemorySessionStore())
|
|
->build();
|
|
```
|
|
|
|
## Recommended Route
|
|
|
|
It's recommended to mount the MCP endpoint at `/mcp`, but this is not enforced:
|
|
|
|
```php
|
|
// Recommended
|
|
Route::any('/mcp', [McpController::class, 'handle']);
|
|
|
|
// Also valid
|
|
Route::any('/', [McpController::class, 'handle']);
|
|
Route::any('/api/mcp', [McpController::class, 'handle']);
|
|
```
|
|
|
|
## Testing HTTP Transport
|
|
|
|
Use the MCP Inspector to test HTTP servers:
|
|
|
|
```bash
|
|
# Start your PHP server
|
|
php -S localhost:8000 server.php
|
|
|
|
# Connect with MCP Inspector
|
|
npx @modelcontextprotocol/inspector http://localhost:8000
|
|
```
|