From 16e02bd3c67974f5a3e30ad8ccd7fdc27eed9c2d Mon Sep 17 00:00:00 2001 From: Jonathan Hefner Date: Mon, 16 Feb 2026 12:29:20 -0600 Subject: [PATCH] fix: resolve TypeDoc warnings from directory-pointing relative links Replace relative markdown links that point to directories with absolute GitHub URLs. TypeDoc cannot copy directories to the output, so these produced warnings that failed the build under `treatWarningsAsErrors`. - README.md: `examples/` and `packages/middleware/` links - packages/middleware/{express,hono,node}/README.md: `../../server/` links Also drop `--emit none` from `docs:check`. TypeDoc only validates relative-link targets during the render phase (in AssetsPlugin.onRenderEnd), so `--emit none` silently skips these checks and `docs:check` passes even when `docs` would fail. Until this is fixed upstream, a full build is needed for `docs:check` to be a reliable CI gate. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 4 ++-- package.json | 2 +- packages/middleware/express/README.md | 2 +- packages/middleware/hono/README.md | 2 +- packages/middleware/node/README.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 745887313..f7242bf99 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.