docs(examples): index missing server and client examples in README#1988
Closed
GopalGB wants to merge 1 commit intomodelcontextprotocol:mainfrom
Closed
docs(examples): index missing server and client examples in README#1988GopalGB wants to merge 1 commit intomodelcontextprotocol:mainfrom
GopalGB wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
Several runnable example files were not listed in the README index tables, leaving them undiscoverable through the canonical entry point: Server: - arktypeExample.ts (ArkType / Standard Schema) - valibotExample.ts (Valibot + @valibot/to-json-schema) - customProtocolVersion.ts (custom protocol-version fallback) Client: - simpleTokenProvider.ts (minimal AuthProvider) - dualModeAuth.ts (host-managed vs OAuth provider) - customMethodExample.ts (vendor-prefixed methods + progress) Adds one row per example to the existing tables. No code changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/fastify
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
Author
|
Closing this on reflection — too lightweight (drive-by docs/typo). Will follow up with a substantive code fix in a separate PR. Apologies for the noise. |
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.
Summary
Several runnable example files exist in
examples/server/src/andexamples/client/src/but are not listed in the example index tables in their respectiveREADME.mdfiles. Users browsing the example READMEs cannot discover them without scanning the directories directly.This PR adds one row per missing example to the existing tables. No code changes.
Why
The README example index is the canonical entry point. Examples that are not listed effectively don't exist for new users — every other example has a row, and the missing ones cover commonly requested scenarios (custom schema validators, custom protocol versions, simple bearer auth).
Changes
examples/server/README.mdAdded rows for:
src/arktypeExample.ts— ArkType / Standard Schema input validationsrc/valibotExample.ts— Valibot +@valibot/to-json-schemavalidationsrc/customProtocolVersion.ts— supporting protocol versions not yet in the SDKexamples/client/README.mdAdded rows for:
src/simpleTokenProvider.ts— minimalAuthProviderfor pre-configured tokenssrc/dualModeAuth.ts— sameauthProvideroption for host-managed and OAuth flowssrc/customMethodExample.ts— vendor-prefixed (acme/search) custom method clientExcluded
Files that are intentionally not standalone runnable examples are not added:
serverGuide.examples.ts/clientGuide.examples.ts— snippet sources synced intodocs/inMemoryEventStore.ts— supporting module imported by the streamable HTTP examplescustomMethodExample.ts(server side) — spawned by the client example via stdioHow to test
examples/server/README.mdandexamples/client/README.mdand confirm the new rows render as part of the existing tables.