Skip to content

Commit c36781b

Browse files
GopalGBclaude
andcommitted
docs(examples): index missing server and client examples in README
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>
1 parent db83829 commit c36781b

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

examples/client/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ Most clients expect a server to be running. Start one from [`../server/README.md
3636
| Client credentials (M2M) | Machine-to-machine OAuth client credentials example. | [`src/simpleClientCredentials.ts`](src/simpleClientCredentials.ts) |
3737
| URL elicitation client | Drives URL-mode elicitation flows (sensitive input in a browser). | [`src/elicitationUrlExample.ts`](src/elicitationUrlExample.ts) |
3838
| Task interactive client | Demonstrates task-based execution + interactive server→client requests. | [`src/simpleTaskInteractiveClient.ts`](src/simpleTaskInteractiveClient.ts) |
39+
| Bearer token provider | Minimal `AuthProvider` for pre-configured bearer tokens (gateway/proxy patterns). | [`src/simpleTokenProvider.ts`](src/simpleTokenProvider.ts) |
40+
| Dual-mode auth | Same `authProvider` option used for host-managed tokens and full OAuth providers. | [`src/dualModeAuth.ts`](src/dualModeAuth.ts) |
41+
| Custom (non-spec) method | Sends a vendor-prefixed `acme/search` request and receives custom progress notifications. | [`src/customMethodExample.ts`](src/customMethodExample.ts) |
3942

4043
## URL elicitation example (server + client)
4144

examples/server/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ pnpm tsx src/simpleStreamableHttp.ts
3939
| Task interactive server | Task-based execution with interactive server→client requests. | [`src/simpleTaskInteractive.ts`](src/simpleTaskInteractive.ts) |
4040
| Hono Streamable HTTP server | Streamable HTTP server built with Hono instead of Express. | [`src/honoWebStandardStreamableHttp.ts`](src/honoWebStandardStreamableHttp.ts) |
4141
| SSE polling demo server | Legacy SSE server intended for polling demos. | [`src/ssePollingExample.ts`](src/ssePollingExample.ts) |
42+
| ArkType schema validation | Minimal stdio server using ArkType (Standard Schema spec) for tool input schemas. | [`src/arktypeExample.ts`](src/arktypeExample.ts) |
43+
| Valibot schema validation | Minimal stdio server using Valibot + `@valibot/to-json-schema` for tool input schemas. | [`src/valibotExample.ts`](src/valibotExample.ts) |
44+
| Custom protocol version support | Supports protocol versions not yet shipped in the SDK; first in list is the fallback. | [`src/customProtocolVersion.ts`](src/customProtocolVersion.ts) |
4245

4346
## OAuth demo flags (Streamable HTTP server)
4447

0 commit comments

Comments
 (0)