Skip to content

docs(examples): index missing server and client examples in README #1988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
GopalGB wants to merge 1 commit into from
+6 −0
Closed

docs(examples): index missing server and client examples in README #1988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions examples/client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Most clients expect a server to be running. Start one from [`../server/README.md
| Client credentials (M2M) | Machine-to-machine OAuth client credentials example. | [`src/simpleClientCredentials.ts`](src/simpleClientCredentials.ts) |
| URL elicitation client | Drives URL-mode elicitation flows (sensitive input in a browser). | [`src/elicitationUrlExample.ts`](src/elicitationUrlExample.ts) |
| Task interactive client | Demonstrates task-based execution + interactive server→client requests. | [`src/simpleTaskInteractiveClient.ts`](src/simpleTaskInteractiveClient.ts) |
| Bearer token provider | Minimal `AuthProvider` for pre-configured bearer tokens (gateway/proxy patterns). | [`src/simpleTokenProvider.ts`](src/simpleTokenProvider.ts) |
| Dual-mode auth | Same `authProvider` option used for host-managed tokens and full OAuth providers. | [`src/dualModeAuth.ts`](src/dualModeAuth.ts) |
| Custom (non-spec) method | Sends a vendor-prefixed `acme/search` request and receives custom progress notifications. | [`src/customMethodExample.ts`](src/customMethodExample.ts) |

## URL elicitation example (server + client)

Expand Down
3 changes: 3 additions & 0 deletions examples/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ pnpm tsx src/simpleStreamableHttp.ts
| Task interactive server | Task-based execution with interactive server→client requests. | [`src/simpleTaskInteractive.ts`](src/simpleTaskInteractive.ts) |
| Hono Streamable HTTP server | Streamable HTTP server built with Hono instead of Express. | [`src/honoWebStandardStreamableHttp.ts`](src/honoWebStandardStreamableHttp.ts) |
| SSE polling demo server | Legacy SSE server intended for polling demos. | [`src/ssePollingExample.ts`](src/ssePollingExample.ts) |
| ArkType schema validation | Minimal stdio server using ArkType (Standard Schema spec) for tool input schemas. | [`src/arktypeExample.ts`](src/arktypeExample.ts) |
| Valibot schema validation | Minimal stdio server using Valibot + `@valibot/to-json-schema` for tool input schemas. | [`src/valibotExample.ts`](src/valibotExample.ts) |
| 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) |

## OAuth demo flags (Streamable HTTP server)

Expand Down
Loading