Repository navigation
[Docs] Bring the docs back in sync with the code - #566
Merged
chr-hertel merged 9 commits intoOct 12, 2026
Merged
Conversation
chr-hertel
requested review from
CodeWithKyrian,
Nyholm and
soyuka
as code owners
October 10, 2026 01:52
This was referenced Oct 10, 2026
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The session-resumption example passes a nullable session ID as an HTTP header value.
1 open finding
What changed in this PR
Aligns documentation and examples with current protocol behavior while fixing modern-era client log filtering.
Changes:
- Applies requested log levels to
ClientLoggeron2026-07-28. - Updates protocol, transport, handler, schema, and client documentation.
- Corrects examples, contribution guidance, roadmap, and changelog history.
| File | Description |
|---|---|
tests/Unit/Server/Stateless/StatelessProtocolTest.php |
Tests modern ClientLogger filtering. |
src/Server/Stateless/StatelessProtocol.php |
Stores request log level in session. |
src/Server/Builder.php |
Corrects notification bus documentation. |
ROADMAP.md |
Marks resource-server authorization complete. |
README.md |
Updates dependencies and documentation links. |
examples/server/README.md |
Clarifies example logging. |
examples/server/oauth-microsoft/.env.dist |
Removes obsolete environment template. |
examples/server/env-variables/server.php |
Corrects example path. |
examples/server/elicitation/server.php |
Corrects documentation reference. |
examples/client/stateless_lifecycle_client.php |
Demonstrates disabling handshake fallback. |
examples/client/README.md |
Updates modern-client behavior. |
examples/client/http_client_communication.php |
Removes obsolete concurrency guidance. |
docs/servers/tools.md |
Corrects naming and structured-output behavior. |
docs/servers/schemas.md |
Documents generation and validation. |
docs/servers/resources.md |
Documents resource-not-found handling. |
docs/servers/resource-templates.md |
Uses the resource-specific exception. |
docs/servers/registration.md |
Corrects registration APIs and validation. |
docs/servers/prompts.md |
Expands supported prompt return values. |
docs/servers/completions.md |
Clarifies provider discovery and registration. |
docs/sdk-tier.md |
Updates conformance gap references. |
docs/run/subscriptions.md |
Clarifies era-specific notification delivery. |
docs/run/stdio.md |
Documents limits and protocol support. |
docs/run/sessions.md |
Adds HTTP session-store guidance. |
docs/run/server-builder.md |
Expands the builder method reference. |
docs/run/protocol-eras.md |
Corrects routing and transport behavior. |
docs/run/index.md |
Distinguishes stateless transport usage. |
docs/run/http.md |
Expands HTTP middleware documentation. |
docs/run/framework-integration.md |
Consolidates session guidance. |
docs/run/authorization.md |
Adds resource documentation metadata. |
docs/protocol-versions.md |
Clarifies client and notification behavior. |
docs/index.md |
Corrects server exit handling. |
docs/handlers/input-required.md |
Documents state and unsupported operations. |
docs/handlers/index.md |
Uses a cross-version elicitation example. |
docs/handlers/client-communication.md |
Corrects metadata and capability documentation. |
docs/get-started/installation.md |
Expands optional dependency guidance. |
docs/get-started/index.md |
Clarifies complete code examples. |
docs/examples.md |
Synchronizes the example catalog. |
docs/client/transports.md |
Documents failures and session IDs. |
docs/client/server-requests.md |
Updates modern request handling examples. |
docs/client/index.md |
Corrects default protocol behavior. |
docs/client/errors.md |
Expands client exception documentation. |
docs/client/connecting.md |
Documents negotiation and capabilities. |
docs/client/capabilities.md |
Handles non-text prompt content. |
docs/advanced/index.md |
Clarifies advanced feature scope. |
docs/advanced/extensions.md |
Documents custom extensions. |
docs/advanced/events.md |
Clarifies event dispatch behavior. |
docs/advanced/custom-handlers.md |
Documents handler limitations. |
CONTRIBUTING.md |
Corrects setup, testing, and BC guidance. |
CHANGELOG.md |
Restores releases and records the fix. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This was referenced Oct 12, 2026
Closed
Closed
chr-hertel
force-pushed
the
docs-sync-with-code
branch
from
October 12, 2026 19:46
2a17c77 to
a1420d6
Compare
Comment on lines
+254
to
+258
| // (null on 2026-07-28 when the server/discover result has no serverInfo) | ||
| $serverInfo = $client->getServerInfo(); | ||
| echo "Server: {$serverInfo->name} v{$serverInfo->version}\n"; | ||
| echo "Server: {$serverInfo?->name} v{$serverInfo?->version}\n"; | ||
|
|
||
| // Get the capabilities the server declared |
Comment on lines
+5
to
+6
| version. After that, the server's capabilities are known and you can use its tools, resources | ||
| and prompts. |
chr-hertel
force-pushed
the
docs-sync-with-code
branch
from
October 12, 2026 20:25
cb88246 to
3184fe0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
server/discoverprobe and handshake fallback now that it defaults to2026-07-28setSchemaValidator(), argument validation,getServerCapabilities(),HttpTransport::getSessionId(), client exceptions, custom extensions and the full builder method tableCLAUDE.mdlink, interop prerequisite), ROADMAP and the 0.7.1/0.8.1 CHANGELOG sectionsClientLoggerignoring the requested log level on2026-07-28requests🤖 Generated with Claude Code