From 028e9999f07d0041ac1e6f630a7d7a122cce1588 Mon Sep 17 00:00:00 2001 From: Jonathan Hefner Date: Tue, 10 Feb 2026 21:10:42 -0600 Subject: [PATCH 1/2] docs: fix TypeDoc warnings for stale `@param` and unexported types - Remove stale `@param resultSchema` from `callToolStream` (parameter doesn't exist) - Export `ClientAuthMethod` type (used as return type of public `selectClientAuthMethod`) - Use `@hidden` instead of `@internal` on `RegisteredTool.executor` and `RegisteredPrompt.handler` to suppress TypeDoc warnings for unexported types Co-Authored-By: Claude Opus 4.6 (1M context) --- packages/client/src/client/auth.ts | 2 +- packages/client/src/experimental/tasks/client.ts | 1 - packages/server/src/server/mcp.ts | 4 ++-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/packages/client/src/client/auth.ts b/packages/client/src/client/auth.ts index 92c76695e..93bab723e 100644 --- a/packages/client/src/client/auth.ts +++ b/packages/client/src/client/auth.ts @@ -193,7 +193,7 @@ export class UnauthorizedError extends Error { } } -type ClientAuthMethod = 'client_secret_basic' | 'client_secret_post' | 'none'; +export type ClientAuthMethod = 'client_secret_basic' | 'client_secret_post' | 'none'; function isClientAuthMethod(method: string): method is ClientAuthMethod { return ['client_secret_basic', 'client_secret_post', 'none'].includes(method); diff --git a/packages/client/src/experimental/tasks/client.ts b/packages/client/src/experimental/tasks/client.ts index fe797017b..4f2bb7543 100644 --- a/packages/client/src/experimental/tasks/client.ts +++ b/packages/client/src/experimental/tasks/client.ts @@ -82,7 +82,6 @@ export class ExperimentalClientTasks { * ``` * * @param params - Tool call parameters (name and arguments) - * @param resultSchema - Zod schema for validating the result (defaults to {@linkcode CallToolResultSchema}) * @param options - Optional request options (timeout, signal, task creation params, etc.) * @returns AsyncGenerator that yields {@linkcode ResponseMessage} objects * diff --git a/packages/server/src/server/mcp.ts b/packages/server/src/server/mcp.ts index e35871096..244586e56 100644 --- a/packages/server/src/server/mcp.ts +++ b/packages/server/src/server/mcp.ts @@ -1008,7 +1008,7 @@ export type RegisteredTool = { execution?: ToolExecution; _meta?: Record; handler: AnyToolHandler; - /** @internal */ + /** @hidden */ executor: ToolExecutor; enabled: boolean; enable(): void; @@ -1147,7 +1147,7 @@ export type RegisteredPrompt = { title?: string; description?: string; argsSchema?: AnySchema; - /** @internal */ + /** @hidden */ handler: PromptHandler; enabled: boolean; enable(): void; From aaafd30d663e5ab8fd879f46048e335f608981d3 Mon Sep 17 00:00:00 2001 From: Jonathan Hefner Date: Tue, 10 Feb 2026 21:11:13 -0600 Subject: [PATCH 2/2] ci: add TypeDoc validation to `check:all` with `treatWarningsAsErrors` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add `treatWarningsAsErrors: true` to `typedoc.config.mjs` so TypeDoc exits non-zero on any warning (stale `@param`, broken `@link`, etc.) - Append `pnpm run docs:check` to the root `check:all` script so CI validates documentation alongside typecheck and lint - Remove per-package `typedoc --emit none` from client and server `check` scripts — the root holistic run is the authoritative check and uses the correct `entryPointStrategy: "packages"` config Co-Authored-By: Claude Opus 4.6 (1M context) --- package.json | 2 +- packages/client/package.json | 2 +- packages/server/package.json | 2 +- typedoc.config.mjs | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 6195e90e0..8c756f032 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "prepack:all": "pnpm -r prepack", "lint:all": "pnpm sync:snippets --check && pnpm -r lint", "lint:fix:all": "pnpm sync:snippets && pnpm -r lint:fix", - "check:all": "pnpm -r typecheck && pnpm -r lint", + "check:all": "pnpm -r typecheck && pnpm -r lint && pnpm run docs:check", "test:all": "pnpm -r test", "test:conformance:client": "pnpm --filter @modelcontextprotocol/test-conformance run test:conformance:client", "test:conformance:client:all": "pnpm --filter @modelcontextprotocol/test-conformance run test:conformance:client:all", diff --git a/packages/client/package.json b/packages/client/package.json index 3ced4ba20..3f606227c 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -55,7 +55,7 @@ "prepack": "npm run build", "lint": "eslint src/ && prettier --ignore-path ../../.prettierignore --check .", "lint:fix": "eslint src/ --fix && prettier --ignore-path ../../.prettierignore --write .", - "check": "npm run typecheck && npm run lint && pnpm exec -- typedoc --emit none", + "check": "npm run typecheck && npm run lint", "test": "vitest run", "test:watch": "vitest", "start": "npm run server", diff --git a/packages/server/package.json b/packages/server/package.json index 882e5f283..9cebe8aed 100644 --- a/packages/server/package.json +++ b/packages/server/package.json @@ -55,7 +55,7 @@ "prepack": "npm run build", "lint": "eslint src/ && prettier --ignore-path ../../.prettierignore --check .", "lint:fix": "eslint src/ --fix && prettier --ignore-path ../../.prettierignore --write .", - "check": "npm run typecheck && npm run lint && pnpm exec -- typedoc --emit none", + "check": "npm run typecheck && npm run lint", "test": "vitest run", "test:watch": "vitest", "start": "npm run server", diff --git a/typedoc.config.mjs b/typedoc.config.mjs index 2fa7289ba..365619844 100644 --- a/typedoc.config.mjs +++ b/typedoc.config.mjs @@ -39,5 +39,6 @@ export default { headings: { readme: false }, + treatWarningsAsErrors: true, out: 'tmp/docs/', };