php-sdk/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Johannes Wachter bdc9d86671
[Client][Server] Add Roots support (#395)
* [Client][Server] Add Roots support

Wire up the MCP "roots" capability on both sides:

Client (php-sdk as client):
- RootsCallbackInterface + ListRootsRequestHandler answer server roots/list
  requests, mirroring the Sampling handler.
- Client::sendRootsListChanged() emits notifications/roots/list_changed.

Server (php-sdk as server):
- ClientGateway::listRoots() requests the client's roots, and
  supportsRoots() reports whether the client advertised the capability,
  normalizing the stored capabilities to an array so an empty
  capabilities object (\stdClass) doesn't cause a TypeError.
- Add ListRootsResult::fromArray() (used by listRoots()).
- ListRootsRequestHandler forwards RootsException messages to the server
  (new Mcp\Exception\RootsException), mirroring SamplingRequestHandler.
- Client::sendRootsListChanged() throws when the client did not advertise
  the roots.listChanged capability.

Examples, docs and tests:
- examples/README/docs advertise
  `new ClientCapabilities(roots: true, rootsListChanged: true)` before
  sending notifications/roots/list_changed.
- CHANGELOG entry for Roots (unreleased 0.7.0 section at the time).
- Unit tests for capability serialization/round-trip, sendRootsListChanged
  gating, and RootsException message forwarding.

phpunit, php-cs-fixer and phpstan green.

* [Client][Server] Address review: schema validation, changelog section, connection guard, working example

Responds to chr-hertel's review of the Roots support:

- ListRootsResult::fromArray() rejects non-array root elements instead of
  accepting malformed entries silently.
- CHANGELOG entry moved to the next unreleased section as the release
  train advanced past it (0.7.0 -> 0.8.0).
- Client::sendRootsListChanged() went straight to
  Protocol::sendNotification(), which sends via
  `$this->transport?->send()` -- on a client that is not connected the
  notification was silently dropped. It now throws a ConnectionException
  like sendRequest() does.
- The stdio example only advertised the roots capability, so the
  roots/list handler never actually ran. The client-communication demo
  server gets an `inspect_workspace_roots` tool that calls
  ClientGateway::supportsRoots()/listRoots(); the example calls it, so
  the server actually issues roots/list and the client answers it.
  Dropped the try/catch wrapper from the example.
- ClientTest's connected-client mock now goes through setState() so
  isConnected() reflects a real handshake instead of a stubbed flag.

phpunit, php-cs-fixer and phpstan green.
2026-08-14 23:04:25 +02:00
..
authorization.md docs(adr): scope OAuth to resource server, not authorization server (#382) 2026-07-06 00:37:19 +02:00
client.md [Client][Server] Add Roots support (#395) 2026-08-14 23:04:25 +02:00
events.md feat(server): add server lifecycle events (#175) 2026-02-23 22:40:43 +01:00
examples.md [Examples] Demo pre-built instance handlers + inspector coverage (#390) 2026-07-15 00:23:20 +02:00
extensions.md [Schema][Server] Add MCP Apps extension (io.modelcontextprotocol/ui) support (#281) 2026-06-01 09:35:54 +01:00
index.md Document v0.6.0 changes in CHANGELOG and docs (#311) 2026-06-02 17:47:04 +02:00
mcp-elements.md Document v0.6.0 changes in CHANGELOG and docs (#311) 2026-06-02 17:47:04 +02:00
server-builder.md [Examples] Demo pre-built instance handlers + inspector coverage (#390) 2026-07-15 00:23:20 +02:00
server-client-communication.md Fix 'notifcation' typo in docs (#410) 2026-08-10 22:09:23 +02:00
transports.md [Server] Harden JSON-RPC input parsing against malformed input and resource exhaustion (#383) 2026-07-06 00:10:13 +02:00