php-sdk/examples/server
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Christopher Hertel e0b9c1a26f
[Server] Serve ClientGateway::elicit() under the modern lifecycle (#466)
One handler asks the user something on any revision now. Where the client
can be asked mid-request it still is; where it cannot, the ask becomes the
input_required result that revision carries and the same call returns the
answer once the client re-sends it.

Costs one handler entry per ask, so side effects belong after the last
question. Answers from earlier rounds travel in the requestState, which is
why asking more than once needs Builder::setRequestState().

sample() and listRoots() still raise a LogicException there: that revision
removed them outright.
2026-08-20 01:25:59 +02:00
..
cached-discovery CS update after release of v3.95 (#282) 2026-04-26 12:39:27 +02:00
client-communication [Client] Speak the 2026-07-28 lifecycle (#456) 2026-08-19 02:41:02 +02:00
client-logging Move examples to server directory (#198) 2025-12-27 15:39:05 +01:00
combined-registration [Examples] Demo pre-built instance handlers + inspector coverage (#390) 2026-07-15 00:23:20 +02:00
complex-tool-schema Use SchemaValidator to validate tool input (#203) 2026-01-11 21:46:53 +01:00
custom-dependencies Update codestyle based on updated Symfony rules (#229) 2026-02-01 11:54:31 +01:00
custom-method-handlers [Schema][Server] Add top-level title to Tool (#288) 2026-04-26 15:37:40 +02:00
discovery-calculator Move examples to server directory (#198) 2025-12-27 15:39:05 +01:00
discovery-userprofile [Schema] Add resource_link content block (#400) 2026-08-14 23:20:56 +02:00
elicitation [Server] Serve ClientGateway::elicit() under the modern lifecycle (#466) 2026-08-20 01:25:59 +02:00
env-variables Update codestyle based on updated Symfony rules (#229) 2026-02-01 11:54:31 +01:00
explicit-registration Move examples to server directory (#198) 2025-12-27 15:39:05 +01:00
mcp-apps [Examples][Tests] Make the MCP Apps example work over HTTP, and pin it (#439) 2026-08-18 14:51:34 +02:00
oauth-keycloak [Server] Compose StreamableHttpTransport security middleware via defaultMiddleware() factory (#307) 2026-05-25 13:49:43 +02:00
oauth-microsoft [Server] Compose StreamableHttpTransport security middleware via defaultMiddleware() factory (#307) 2026-05-25 13:49:43 +02:00
schema-showcase Update codestyle based on updated Symfony rules (#229) 2026-02-01 11:54:31 +01:00
stateless-lifecycle [Docs][Examples][CI] Document and gate the 2026-07-28 lifecycle (#457) 2026-08-19 03:24:17 +02:00
bootstrap.php [Server] Serve both protocol eras from one endpoint (#455) 2026-08-19 01:36:56 +02:00
README.md [Docs] Render the guides with Zensical instead of phpDocumentor (#414) 2026-08-20 00:03:54 +02:00

MCP SDK Examples

This directory contains various examples of how to use the PHP MCP SDK.

You can run the examples with the dependencies already installed in the root directory of the SDK. The bootstrapping of the example will choose the used transport based on the SAPI you use.

For running an example, you execute the server.php like this:

# For using the STDIO transport:
php examples/server/discovery-calculator/server.php

# For using the Streamable HTTP transport:
php -S localhost:8000 examples/server/discovery-userprofile/server.php

You will see debug outputs to help you understand what is happening.

Run with Inspector:

npx @modelcontextprotocol/inspector php examples/server/discovery-calculator/server.php

The 2026-07-28 lifecycle

stateless-lifecycle/server.php demonstrates protocol revision 2026-07-28, which removed the initialize handshake and protocol-level sessions. Like every example it answers both eras — the Inspector's initialize still works — but the interesting part is the modern one:

php -S 127.0.0.1:8000 examples/server/stateless-lifecycle/server.php

Every request carries its own protocol version and client capabilities, so a call is a single POST with no handshake before it:

curl -sS http://127.0.0.1:8000/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -H 'MCP-Protocol-Version: 2026-07-28' \
  -H 'Mcp-Method: server/discover' \
  -d '{"jsonrpc":"2.0","id":1,"method":"server/discover","params":{"_meta":{
        "io.modelcontextprotocol/protocolVersion":"2026-07-28",
        "io.modelcontextprotocol/clientCapabilities":{}}}}'

tests/Integration/StatelessLifecycleTest.php drives this example end to end — discovery, a tool call, the multi round-trip flow, and the response stream carrying progress and log notifications.

Debugging

You can enable debug output by setting the DEBUG environment variable to 1, and additionally log to a file by setting the FILE_LOG environment variable to 1 as well. A dev.log file gets written within the example's directory.

With the Inspector you can set the environment variables like this:

npx @modelcontextprotocol/inspector -e DEBUG=1 -e FILE_LOG=1 php examples/server/discovery-calculator/server.php