diff --git a/README.md b/README.md index 790270520..3bd832f88 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ This repository contains the TypeScript SDK implementation of the MCP specificat - MCP **server** libraries (tools/resources/prompts, Streamable HTTP, stdio, auth helpers) - MCP **client** libraries (transports, high-level helpers, OAuth helpers) - Optional **middleware packages** for specific runtimes/frameworks (Express, Hono, Node.js HTTP) -- Runnable **examples** (under [`examples/`](examples/)) +- Runnable **examples** (under [`examples/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples)) ## Packages @@ -43,7 +43,7 @@ Both packages have a **required peer dependency** on `zod` for schema validation ### Middleware packages (optional) -The SDK also publishes small “middleware” packages under [`packages/middleware/`](packages/middleware/) that help you **wire MCP into a specific runtime or web framework**. +The SDK also publishes small "middleware" packages under [`packages/middleware/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/packages/middleware) that help you **wire MCP into a specific runtime or web framework**. They are intentionally thin adapters: they should not introduce new MCP functionality or business logic. See [`packages/middleware/README.md`](packages/middleware/README.md) for details. diff --git a/package.json b/package.json index 8c756f032..720950472 100644 --- a/package.json +++ b/package.json @@ -26,7 +26,7 @@ "sync:snippets": "tsx scripts/sync-snippets.ts", "examples:simple-server:w": "pnpm --filter @modelcontextprotocol/examples-server exec tsx --watch src/simpleStreamableHttp.ts --oauth", "docs": "typedoc", - "docs:check": "typedoc --emit none", + "docs:check": "typedoc", "typecheck:all": "pnpm -r typecheck", "build:all": "pnpm -r build", "prepack:all": "pnpm -r prepack", diff --git a/packages/middleware/express/README.md b/packages/middleware/express/README.md index 386141d14..99189aa20 100644 --- a/packages/middleware/express/README.md +++ b/packages/middleware/express/README.md @@ -2,7 +2,7 @@ Express adapters for the MCP TypeScript server SDK. -This package is a thin Express integration layer for [`@modelcontextprotocol/server`](../../server/). +This package is a thin Express integration layer for [`@modelcontextprotocol/server`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/packages/server). It does **not** implement MCP itself. Instead, it helps you: diff --git a/packages/middleware/hono/README.md b/packages/middleware/hono/README.md index a7339bf68..f59188850 100644 --- a/packages/middleware/hono/README.md +++ b/packages/middleware/hono/README.md @@ -2,7 +2,7 @@ Hono adapters for the MCP TypeScript server SDK. -This package is a thin Hono integration layer for [`@modelcontextprotocol/server`](../../server/). +This package is a thin Hono integration layer for [`@modelcontextprotocol/server`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/packages/server). It does **not** implement MCP itself. Instead, it helps you: diff --git a/packages/middleware/node/README.md b/packages/middleware/node/README.md index 678e1d452..fe10c9f2a 100644 --- a/packages/middleware/node/README.md +++ b/packages/middleware/node/README.md @@ -2,7 +2,7 @@ Node.js adapters for the MCP TypeScript server SDK. -This package is a thin Node.js integration layer for [`@modelcontextprotocol/server`](../../server/). It provides a Streamable HTTP transport that works with Node’s `IncomingMessage` / `ServerResponse`. +This package is a thin Node.js integration layer for [`@modelcontextprotocol/server`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/packages/server). It provides a Streamable HTTP transport that works with Node’s `IncomingMessage` / `ServerResponse`. For web‑standard runtimes (Cloudflare Workers, Deno, Bun, etc.), use `WebStandardStreamableHTTPServerTransport` from `@modelcontextprotocol/server` directly.