Skip to content

Commit 16e02bd

Browse files
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) <noreply@anthropic.com>
1 parent dc896e1 commit 16e02bd

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This repository contains the TypeScript SDK implementation of the MCP specificat
3030
- MCP **server** libraries (tools/resources/prompts, Streamable HTTP, stdio, auth helpers)
3131
- MCP **client** libraries (transports, high-level helpers, OAuth helpers)
3232
- Optional **middleware packages** for specific runtimes/frameworks (Express, Hono, Node.js HTTP)
33-
- Runnable **examples** (under [`examples/`](examples/))
33+
- Runnable **examples** (under [`examples/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples))
3434

3535
## Packages
3636

@@ -43,7 +43,7 @@ Both packages have a **required peer dependency** on `zod` for schema validation
4343

4444
### Middleware packages (optional)
4545

46-
The SDK also publishes small middleware packages under [`packages/middleware/`](packages/middleware/) that help you **wire MCP into a specific runtime or web framework**.
46+
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**.
4747

4848
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.
4949

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"sync:snippets": "tsx scripts/sync-snippets.ts",
2727
"examples:simple-server:w": "pnpm --filter @modelcontextprotocol/examples-server exec tsx --watch src/simpleStreamableHttp.ts --oauth",
2828
"docs": "typedoc",
29-
"docs:check": "typedoc --emit none",
29+
"docs:check": "typedoc",
3030
"typecheck:all": "pnpm -r typecheck",
3131
"build:all": "pnpm -r build",
3232
"prepack:all": "pnpm -r prepack",

packages/middleware/express/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Express adapters for the MCP TypeScript server SDK.
44

5-
This package is a thin Express integration layer for [`@modelcontextprotocol/server`](../../server/).
5+
This package is a thin Express integration layer for [`@modelcontextprotocol/server`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/packages/server).
66

77
It does **not** implement MCP itself. Instead, it helps you:
88

packages/middleware/hono/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Hono adapters for the MCP TypeScript server SDK.
44

5-
This package is a thin Hono integration layer for [`@modelcontextprotocol/server`](../../server/).
5+
This package is a thin Hono integration layer for [`@modelcontextprotocol/server`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/packages/server).
66

77
It does **not** implement MCP itself. Instead, it helps you:
88

packages/middleware/node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Node.js adapters for the MCP TypeScript server SDK.
44

5-
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`.
5+
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`.
66

77
For web‑standard runtimes (Cloudflare Workers, Deno, Bun, etc.), use `WebStandardStreamableHTTPServerTransport` from `@modelcontextprotocol/server` directly.
88

0 commit comments

Comments
 (0)