Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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
jake-danton wants to merge 3 commits into from
Closed

Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e55c327
tests passing
jake-danton Sep 2, 2025
63930d5
Merge branch 'modelcontextprotocol:main' into zod-v4-v3
jake-danton Sep 2, 2025
b01ef0b
fixing linting
jake-danton Sep 2, 2025
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
23 changes: 8 additions & 15 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
"express": "^5.0.1",
"express-rate-limit": "^7.5.0",
"pkce-challenge": "^5.0.0",
"raw-body": "^3.0.0",
"zod": "^3.23.8",
"zod-to-json-schema": "^3.24.1"
"raw-body": "^3.0.0"
},
"devDependencies": {
"@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
"typescript-eslint": "^8.0.0",
"ws": "^8.18.0"
},
"peerDependencies": {
"zod": "^4.1.5"
},
"resolutions": {
"strip-ansi": "6.0.1"
}
}
}
4 changes: 2 additions & 2 deletions src/examples/server/simpleSseServer.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
'start-notification-stream',
'Starts sending periodic notifications',
{
interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
count: z.number().describe('Number of notifications to send').default(10),
interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
count: z.number().describe('Number of notifications to send').prefault(10),
},
async ({ interval, count }, extra): Promise<CallToolResult> => {
const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down
4 changes: 2 additions & 2 deletions src/examples/server/simpleStatelessStreamableHttp.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
'start-notification-stream',
'Starts sending periodic notifications for testing resumability',
{
interval: z.number().describe('Interval in milliseconds between notifications').default(100),
count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
},
async ({ interval, count }, extra): Promise<CallToolResult> => {
const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down
4 changes: 2 additions & 2 deletions src/examples/server/simpleStreamableHttp.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
'start-notification-stream',
'Starts sending periodic notifications for testing resumability',
{
interval: z.number().describe('Interval in milliseconds between notifications').default(100),
count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
},
async ({ interval, count }, extra): Promise<CallToolResult> => {
const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down
4 changes: 2 additions & 2 deletions src/examples/server/sseAndStreamableHttpCompatibleServer.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
'start-notification-stream',
'Starts sending periodic notifications for testing resumability',
{
interval: z.number().describe('Interval in milliseconds between notifications').default(100),
count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
},
async ({ interval, count }, extra): Promise<CallToolResult> => {
const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down
2 changes: 1 addition & 1 deletion src/integration-tests/stateManagementStreamableHttp.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
'greet',
'A simple greeting tool',
{
name: z.string().describe('Name to greet').default('World'),
name: z.string().describe('Name to greet').prefault('World'),
},
async ({ name }) => {
return {
Expand Down
6 changes: 3 additions & 3 deletions src/integration-tests/taskResumability.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
'send-notification',
'Sends a single notification',
{
message: z.string().describe('Message to send').default('Test notification')
message: z.string().describe('Message to send').prefault('Test notification')
},
async ({ message }, { sendNotification }) => {
// Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
'run-notifications',
'Sends multiple notifications over time',
{
count: z.number().describe('Number of notifications to send').default(10),
interval: z.number().describe('Interval between notifications in ms').default(50)
count: z.number().describe('Number of notifications to send').prefault(10),
interval: z.number().describe('Interval between notifications in ms').prefault(50)
},
async ({ count, interval }, { sendNotification }) => {
// Send notifications at specified intervals
Expand Down
6 changes: 4 additions & 2 deletions src/server/auth/handlers/authorize.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
client_id: z.string(),
redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
code_challenge_method: z.literal("S256"),
scope: z.string().optional(),
state: z.string().optional(),
resource: z.string().url().optional(),
resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down
4 changes: 2 additions & 2 deletions src/server/auth/handlers/token.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
code: z.string(),
code_verifier: z.string(),
redirect_uri: z.string().optional(),
resource: z.string().url().optional(),
resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
refresh_token: z.string(),
scope: z.string().optional(),
resource: z.string().url().optional(),
resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down
12 changes: 7 additions & 5 deletions src/server/completable.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
const completions = ["foo", "bar", "baz"];
const schema = completable(z.string(), () => completions);

expect(await schema._def.complete("")).toEqual(completions);
expect(await schema.def.complete("")).toEqual(completions);
});

it("allows async completion functions", async () => {
const completions = ["foo", "bar", "baz"];
const schema = completable(z.string(), async () => completions);

expect(await schema._def.complete("")).toEqual(completions);
expect(await schema.def.complete("")).toEqual(completions);
});

it("passes current value to completion function", async () => {
const schema = completable(z.string(), (value) => [value + "!"]);

expect(await schema._def.complete("test")).toEqual(["test!"]);
expect(await schema.def.complete("test")).toEqual(["test!"]);
});

it("works with number schemas", async () => {
const schema = completable(z.number(), () => [1, 2, 3]);

expect(schema.parse(1)).toBe(1);
expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
});

it("preserves schema description", () => {
// This is no longer how zod behavior works
// See: https://github.com/colinhacks/zod/issues/4965
it.skip("preserves schema description", () => {
const desc = "test description";
const schema = completable(z.string().describe(desc), () => []);

Expand Down
133 changes: 53 additions & 80 deletions src/server/completable.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
ZodTypeAny,
ZodTypeDef,
ZodType,
ParseInput,
ParseReturnType,
RawCreateParams,
ZodErrorMap,
ProcessedCreateParams,
z,
} from "zod";

export enum McpZodTypeKind {
Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
value: z.input<T>,
context?: {
arguments?: Record<string, string>;
},
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
complete: CompleteCallback<T>;
typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
T["_output"],
CompletableDef<T>,
T["_input"]
> {
_parse(input: ParseInput): ParseReturnType<this["_output"]> {
const { ctx } = this._processInputParams(input);
const data = ctx.data;
return this._def.type._parse({
data,
path: ctx.path,
parent: ctx,
});
}
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
def: $CompletableDef<T>;
isst: never;
/** Auto-cached way to retrieve the inner schema */
innerType: T;
pattern: T["_zod"]["pattern"];
propValues: T["_zod"]["propValues"];
optin: T["_zod"]["optin"];
optout: T["_zod"]["optout"];
}

unwrap() {
return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

static create = <T extends ZodTypeAny>(
type: T,
params: RawCreateParams & {
complete: CompleteCallback<T>;
},
): Completable<T> => {
return new Completable({
type,
typeName: McpZodTypeKind.Completable,
complete: params.complete,
...processCreateParams(params),
});
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
z.core.$ZodType.init(inst, def);

z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

inst._zod.parse = (payload, ctx) => {
return def.innerType._zod.run(payload, ctx);
};
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
extends z._ZodType<$CompletableInternals<T>>,
$Completable<T> {
complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
$Completable.init(inst, def);
z.ZodType.init(inst, def);

inst.complete = def.complete;
});

/**
* Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
*/
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
schema: T,
complete: CompleteCallback<T>,
): Completable<T> {
return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
if (!params) return {};
const { errorMap, invalid_type_error, required_error, description } = params;
if (errorMap && (invalid_type_error || required_error)) {
throw new Error(
`Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
);
}
if (errorMap) return { errorMap: errorMap, description };
const customMap: ZodErrorMap = (iss, ctx) => {
const { message } = params;

if (iss.code === "invalid_enum_value") {
return { message: message ?? ctx.defaultError };
}
if (typeof ctx.data === "undefined") {
return { message: message ?? required_error ?? ctx.defaultError };
}
if (iss.code !== "invalid_type") return { message: ctx.defaultError };
return { message: message ?? invalid_type_error ?? ctx.defaultError };
};
return { errorMap: customMap, description };
}
return new Completable({
type: "custom",
innerType: schema,
complete: complete,
}) as Completable<T>;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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

jake-danton
wants to merge
3
commits into

from

 Closed


Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema
#914
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e55c327

tests passing


jake-danton Sep 2, 2025
63930d5

Merge branch 'modelcontextprotocol:main' into zod-v4-v3


jake-danton Sep 2, 2025
b01ef0b

fixing linting


jake-danton Sep 2, 2025

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


23 changes: 8 additions & 15 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


9 changes: 5 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
 "express": "^5.0.1",
 "express-rate-limit": "^7.5.0",
 "pkce-challenge": "^5.0.0",
 "raw-body": "^3.0.0",
 "zod": "^3.23.8",
 "zod-to-json-schema": "^3.24.1"
 "raw-body": "^3.0.0"
 },
 "devDependencies": {
 "@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
 "typescript-eslint": "^8.0.0",
 "ws": "^8.18.0"
 },
 "peerDependencies": {
 "zod": "^4.1.5"
 },
 "resolutions": {
 "strip-ansi": "6.0.1"
 }
}
}

4 changes: 2 additions & 2 deletions
src/examples/server/simpleSseServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
 count: z.number().describe('Number of notifications to send').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStatelessStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/sseAndStreamableHttpCompatibleServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

2 changes: 1 addition & 1 deletion
src/integration-tests/stateManagementStreamableHttp.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
 'greet',
 'A simple greeting tool',
 {
 name: z.string().describe('Name to greet').default('World'),
 name: z.string().describe('Name to greet').prefault('World'),
 },
 async ({ name }) => {
 return {
Expand Down

6 changes: 3 additions & 3 deletions
src/integration-tests/taskResumability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
 'send-notification',
 'Sends a single notification',
 {
 message: z.string().describe('Message to send').default('Test notification')
 message: z.string().describe('Message to send').prefault('Test notification')
 },
 async ({ message }, { sendNotification }) => {
 // Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
 'run-notifications',
 'Sends multiple notifications over time',
 {
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval between notifications in ms').default(50)
 count: z.number().describe('Number of notifications to send').prefault(10),
 interval: z.number().describe('Interval between notifications in ms').prefault(50)
 },
 async ({ count, interval }, { sendNotification }) => {
 // Send notifications at specified intervals
Expand Down

6 changes: 4 additions & 2 deletions
src/server/auth/handlers/authorize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
 client_id: z.string(),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
 error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
 code_challenge_method: z.literal("S256"),
 scope: z.string().optional(),
 state: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down

4 changes: 2 additions & 2 deletions
src/server/auth/handlers/token.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
 code: z.string(),
 code_verifier: z.string(),
 redirect_uri: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
 refresh_token: z.string(),
 scope: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down

12 changes: 7 additions & 5 deletions
src/server/completable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("allows async completion functions", async () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), async () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("passes current value to completion function", async () => {
 const schema = completable(z.string(), (value) => [value + "!"]);

 expect(await schema._def.complete("test")).toEqual(["test!"]);
 expect(await schema.def.complete("test")).toEqual(["test!"]);
 });

 it("works with number schemas", async () => {
 const schema = completable(z.number(), () => [1, 2, 3]);

 expect(schema.parse(1)).toBe(1);
 expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
 expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
 });

 it("preserves schema description", () => {
 // This is no longer how zod behavior works
 // See: https://github.com/colinhacks/zod/issues/4965
 it.skip("preserves schema description", () => {
 const desc = "test description";
 const schema = completable(z.string().describe(desc), () => []);

Expand Down

133 changes: 53 additions & 80 deletions
src/server/completable.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
 ZodTypeAny,
 ZodTypeDef,
 ZodType,
 ParseInput,
 ParseReturnType,
 RawCreateParams,
 ZodErrorMap,
 ProcessedCreateParams,
 z,
} from "zod";

export enum McpZodTypeKind {
 Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
 value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
 value: z.input<T>,
 context?: {
 arguments?: Record<string, string>;
 },
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
 complete: CompleteCallback<T>;
 typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
 T["_output"],
 CompletableDef<T>,
 T["_input"]
> {
 _parse(input: ParseInput): ParseReturnType<this["_output"]> {
 const { ctx } = this._processInputParams(input);
 const data = ctx.data;
 return this._def.type._parse({
 data,
 path: ctx.path,
 parent: ctx,
 });
 }
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
 extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
 def: $CompletableDef<T>;
 isst: never;
 /** Auto-cached way to retrieve the inner schema */
 innerType: T;
 pattern: T["_zod"]["pattern"];
 propValues: T["_zod"]["propValues"];
 optin: T["_zod"]["optin"];
 optout: T["_zod"]["optout"];
}

 unwrap() {
 return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

 static create = <T extends ZodTypeAny>(
 type: T,
 params: RawCreateParams & {
 complete: CompleteCallback<T>;
 },
 ): Completable<T> => {
 return new Completable({
 type,
 typeName: McpZodTypeKind.Completable,
 complete: params.complete,
 ...processCreateParams(params),
 });
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
 z.core.$ZodType.init(inst, def);

 z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
 z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
 z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
 z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
 z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

 inst._zod.parse = (payload, ctx) => {
 return def.innerType._zod.run(payload, ctx);
 };
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
 extends z._ZodType<$CompletableInternals<T>>,
 $Completable<T> {
 complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
 $Completable.init(inst, def);
 z.ZodType.init(inst, def);

 inst.complete = def.complete;
});

/**
 * Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
 */
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
 schema: T,
 complete: CompleteCallback<T>,
): Completable<T> {
 return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
 if (!params) return {};
 const { errorMap, invalid_type_error, required_error, description } = params;
 if (errorMap && (invalid_type_error || required_error)) {
 throw new Error(
 `Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
 );
 }
 if (errorMap) return { errorMap: errorMap, description };
 const customMap: ZodErrorMap = (iss, ctx) => {
 const { message } = params;

 if (iss.code === "invalid_enum_value") {
 return { message: message ?? ctx.defaultError };
 }
 if (typeof ctx.data === "undefined") {
 return { message: message ?? required_error ?? ctx.defaultError };
 }
 if (iss.code !== "invalid_type") return { message: ctx.defaultError };
 return { message: message ?? invalid_type_error ?? ctx.defaultError };
 };
 return { errorMap: customMap, description };
}
 return new Completable({
 type: "custom",
 innerType: schema,
 complete: complete,
 }) as Completable<T>;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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

jake-danton
wants to merge
3
commits into

from

 Closed


Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema
#914
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e55c327

tests passing


jake-danton Sep 2, 2025
63930d5

Merge branch 'modelcontextprotocol:main' into zod-v4-v3


jake-danton Sep 2, 2025
b01ef0b

fixing linting


jake-danton Sep 2, 2025

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


23 changes: 8 additions & 15 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


9 changes: 5 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
 "express": "^5.0.1",
 "express-rate-limit": "^7.5.0",
 "pkce-challenge": "^5.0.0",
 "raw-body": "^3.0.0",
 "zod": "^3.23.8",
 "zod-to-json-schema": "^3.24.1"
 "raw-body": "^3.0.0"
 },
 "devDependencies": {
 "@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
 "typescript-eslint": "^8.0.0",
 "ws": "^8.18.0"
 },
 "peerDependencies": {
 "zod": "^4.1.5"
 },
 "resolutions": {
 "strip-ansi": "6.0.1"
 }
}
}

4 changes: 2 additions & 2 deletions
src/examples/server/simpleSseServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
 count: z.number().describe('Number of notifications to send').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStatelessStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/sseAndStreamableHttpCompatibleServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

2 changes: 1 addition & 1 deletion
src/integration-tests/stateManagementStreamableHttp.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
 'greet',
 'A simple greeting tool',
 {
 name: z.string().describe('Name to greet').default('World'),
 name: z.string().describe('Name to greet').prefault('World'),
 },
 async ({ name }) => {
 return {
Expand Down

6 changes: 3 additions & 3 deletions
src/integration-tests/taskResumability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
 'send-notification',
 'Sends a single notification',
 {
 message: z.string().describe('Message to send').default('Test notification')
 message: z.string().describe('Message to send').prefault('Test notification')
 },
 async ({ message }, { sendNotification }) => {
 // Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
 'run-notifications',
 'Sends multiple notifications over time',
 {
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval between notifications in ms').default(50)
 count: z.number().describe('Number of notifications to send').prefault(10),
 interval: z.number().describe('Interval between notifications in ms').prefault(50)
 },
 async ({ count, interval }, { sendNotification }) => {
 // Send notifications at specified intervals
Expand Down

6 changes: 4 additions & 2 deletions
src/server/auth/handlers/authorize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
 client_id: z.string(),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
 error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
 code_challenge_method: z.literal("S256"),
 scope: z.string().optional(),
 state: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down

4 changes: 2 additions & 2 deletions
src/server/auth/handlers/token.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
 code: z.string(),
 code_verifier: z.string(),
 redirect_uri: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
 refresh_token: z.string(),
 scope: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down

12 changes: 7 additions & 5 deletions
src/server/completable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("allows async completion functions", async () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), async () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("passes current value to completion function", async () => {
 const schema = completable(z.string(), (value) => [value + "!"]);

 expect(await schema._def.complete("test")).toEqual(["test!"]);
 expect(await schema.def.complete("test")).toEqual(["test!"]);
 });

 it("works with number schemas", async () => {
 const schema = completable(z.number(), () => [1, 2, 3]);

 expect(schema.parse(1)).toBe(1);
 expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
 expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
 });

 it("preserves schema description", () => {
 // This is no longer how zod behavior works
 // See: https://github.com/colinhacks/zod/issues/4965
 it.skip("preserves schema description", () => {
 const desc = "test description";
 const schema = completable(z.string().describe(desc), () => []);

Expand Down

133 changes: 53 additions & 80 deletions
src/server/completable.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
 ZodTypeAny,
 ZodTypeDef,
 ZodType,
 ParseInput,
 ParseReturnType,
 RawCreateParams,
 ZodErrorMap,
 ProcessedCreateParams,
 z,
} from "zod";

export enum McpZodTypeKind {
 Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
 value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
 value: z.input<T>,
 context?: {
 arguments?: Record<string, string>;
 },
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
 complete: CompleteCallback<T>;
 typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
 T["_output"],
 CompletableDef<T>,
 T["_input"]
> {
 _parse(input: ParseInput): ParseReturnType<this["_output"]> {
 const { ctx } = this._processInputParams(input);
 const data = ctx.data;
 return this._def.type._parse({
 data,
 path: ctx.path,
 parent: ctx,
 });
 }
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
 extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
 def: $CompletableDef<T>;
 isst: never;
 /** Auto-cached way to retrieve the inner schema */
 innerType: T;
 pattern: T["_zod"]["pattern"];
 propValues: T["_zod"]["propValues"];
 optin: T["_zod"]["optin"];
 optout: T["_zod"]["optout"];
}

 unwrap() {
 return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

 static create = <T extends ZodTypeAny>(
 type: T,
 params: RawCreateParams & {
 complete: CompleteCallback<T>;
 },
 ): Completable<T> => {
 return new Completable({
 type,
 typeName: McpZodTypeKind.Completable,
 complete: params.complete,
 ...processCreateParams(params),
 });
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
 z.core.$ZodType.init(inst, def);

 z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
 z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
 z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
 z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
 z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

 inst._zod.parse = (payload, ctx) => {
 return def.innerType._zod.run(payload, ctx);
 };
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
 extends z._ZodType<$CompletableInternals<T>>,
 $Completable<T> {
 complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
 $Completable.init(inst, def);
 z.ZodType.init(inst, def);

 inst.complete = def.complete;
});

/**
 * Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
 */
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
 schema: T,
 complete: CompleteCallback<T>,
): Completable<T> {
 return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
 if (!params) return {};
 const { errorMap, invalid_type_error, required_error, description } = params;
 if (errorMap && (invalid_type_error || required_error)) {
 throw new Error(
 `Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
 );
 }
 if (errorMap) return { errorMap: errorMap, description };
 const customMap: ZodErrorMap = (iss, ctx) => {
 const { message } = params;

 if (iss.code === "invalid_enum_value") {
 return { message: message ?? ctx.defaultError };
 }
 if (typeof ctx.data === "undefined") {
 return { message: message ?? required_error ?? ctx.defaultError };
 }
 if (iss.code !== "invalid_type") return { message: ctx.defaultError };
 return { message: message ?? invalid_type_error ?? ctx.defaultError };
 };
 return { errorMap: customMap, description };
}
 return new Completable({
 type: "custom",
 innerType: schema,
 complete: complete,
 }) as Completable<T>;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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

jake-danton
wants to merge
3
commits into

from

 Closed


Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema
#914
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e55c327

tests passing


jake-danton Sep 2, 2025
63930d5

Merge branch 'modelcontextprotocol:main' into zod-v4-v3


jake-danton Sep 2, 2025
b01ef0b

fixing linting


jake-danton Sep 2, 2025

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


23 changes: 8 additions & 15 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


9 changes: 5 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
 "express": "^5.0.1",
 "express-rate-limit": "^7.5.0",
 "pkce-challenge": "^5.0.0",
 "raw-body": "^3.0.0",
 "zod": "^3.23.8",
 "zod-to-json-schema": "^3.24.1"
 "raw-body": "^3.0.0"
 },
 "devDependencies": {
 "@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
 "typescript-eslint": "^8.0.0",
 "ws": "^8.18.0"
 },
 "peerDependencies": {
 "zod": "^4.1.5"
 },
 "resolutions": {
 "strip-ansi": "6.0.1"
 }
}
}

4 changes: 2 additions & 2 deletions
src/examples/server/simpleSseServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
 count: z.number().describe('Number of notifications to send').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStatelessStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/sseAndStreamableHttpCompatibleServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

2 changes: 1 addition & 1 deletion
src/integration-tests/stateManagementStreamableHttp.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
 'greet',
 'A simple greeting tool',
 {
 name: z.string().describe('Name to greet').default('World'),
 name: z.string().describe('Name to greet').prefault('World'),
 },
 async ({ name }) => {
 return {
Expand Down

6 changes: 3 additions & 3 deletions
src/integration-tests/taskResumability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
 'send-notification',
 'Sends a single notification',
 {
 message: z.string().describe('Message to send').default('Test notification')
 message: z.string().describe('Message to send').prefault('Test notification')
 },
 async ({ message }, { sendNotification }) => {
 // Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
 'run-notifications',
 'Sends multiple notifications over time',
 {
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval between notifications in ms').default(50)
 count: z.number().describe('Number of notifications to send').prefault(10),
 interval: z.number().describe('Interval between notifications in ms').prefault(50)
 },
 async ({ count, interval }, { sendNotification }) => {
 // Send notifications at specified intervals
Expand Down

6 changes: 4 additions & 2 deletions
src/server/auth/handlers/authorize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
 client_id: z.string(),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
 error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
 code_challenge_method: z.literal("S256"),
 scope: z.string().optional(),
 state: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down

4 changes: 2 additions & 2 deletions
src/server/auth/handlers/token.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
 code: z.string(),
 code_verifier: z.string(),
 redirect_uri: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
 refresh_token: z.string(),
 scope: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down

12 changes: 7 additions & 5 deletions
src/server/completable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("allows async completion functions", async () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), async () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("passes current value to completion function", async () => {
 const schema = completable(z.string(), (value) => [value + "!"]);

 expect(await schema._def.complete("test")).toEqual(["test!"]);
 expect(await schema.def.complete("test")).toEqual(["test!"]);
 });

 it("works with number schemas", async () => {
 const schema = completable(z.number(), () => [1, 2, 3]);

 expect(schema.parse(1)).toBe(1);
 expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
 expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
 });

 it("preserves schema description", () => {
 // This is no longer how zod behavior works
 // See: https://github.com/colinhacks/zod/issues/4965
 it.skip("preserves schema description", () => {
 const desc = "test description";
 const schema = completable(z.string().describe(desc), () => []);

Expand Down

133 changes: 53 additions & 80 deletions
src/server/completable.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
 ZodTypeAny,
 ZodTypeDef,
 ZodType,
 ParseInput,
 ParseReturnType,
 RawCreateParams,
 ZodErrorMap,
 ProcessedCreateParams,
 z,
} from "zod";

export enum McpZodTypeKind {
 Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
 value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
 value: z.input<T>,
 context?: {
 arguments?: Record<string, string>;
 },
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
 complete: CompleteCallback<T>;
 typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
 T["_output"],
 CompletableDef<T>,
 T["_input"]
> {
 _parse(input: ParseInput): ParseReturnType<this["_output"]> {
 const { ctx } = this._processInputParams(input);
 const data = ctx.data;
 return this._def.type._parse({
 data,
 path: ctx.path,
 parent: ctx,
 });
 }
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
 extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
 def: $CompletableDef<T>;
 isst: never;
 /** Auto-cached way to retrieve the inner schema */
 innerType: T;
 pattern: T["_zod"]["pattern"];
 propValues: T["_zod"]["propValues"];
 optin: T["_zod"]["optin"];
 optout: T["_zod"]["optout"];
}

 unwrap() {
 return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

 static create = <T extends ZodTypeAny>(
 type: T,
 params: RawCreateParams & {
 complete: CompleteCallback<T>;
 },
 ): Completable<T> => {
 return new Completable({
 type,
 typeName: McpZodTypeKind.Completable,
 complete: params.complete,
 ...processCreateParams(params),
 });
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
 z.core.$ZodType.init(inst, def);

 z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
 z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
 z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
 z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
 z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

 inst._zod.parse = (payload, ctx) => {
 return def.innerType._zod.run(payload, ctx);
 };
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
 extends z._ZodType<$CompletableInternals<T>>,
 $Completable<T> {
 complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
 $Completable.init(inst, def);
 z.ZodType.init(inst, def);

 inst.complete = def.complete;
});

/**
 * Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
 */
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
 schema: T,
 complete: CompleteCallback<T>,
): Completable<T> {
 return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
 if (!params) return {};
 const { errorMap, invalid_type_error, required_error, description } = params;
 if (errorMap && (invalid_type_error || required_error)) {
 throw new Error(
 `Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
 );
 }
 if (errorMap) return { errorMap: errorMap, description };
 const customMap: ZodErrorMap = (iss, ctx) => {
 const { message } = params;

 if (iss.code === "invalid_enum_value") {
 return { message: message ?? ctx.defaultError };
 }
 if (typeof ctx.data === "undefined") {
 return { message: message ?? required_error ?? ctx.defaultError };
 }
 if (iss.code !== "invalid_type") return { message: ctx.defaultError };
 return { message: message ?? invalid_type_error ?? ctx.defaultError };
 };
 return { errorMap: customMap, description };
}
 return new Completable({
 type: "custom",
 innerType: schema,
 complete: complete,
 }) as Completable<T>;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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

jake-danton
wants to merge
3
commits into

from

 Closed


Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema
#914
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e55c327

tests passing


jake-danton Sep 2, 2025
63930d5

Merge branch 'modelcontextprotocol:main' into zod-v4-v3


jake-danton Sep 2, 2025
b01ef0b

fixing linting


jake-danton Sep 2, 2025

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


23 changes: 8 additions & 15 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


9 changes: 5 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
 "express": "^5.0.1",
 "express-rate-limit": "^7.5.0",
 "pkce-challenge": "^5.0.0",
 "raw-body": "^3.0.0",
 "zod": "^3.23.8",
 "zod-to-json-schema": "^3.24.1"
 "raw-body": "^3.0.0"
 },
 "devDependencies": {
 "@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
 "typescript-eslint": "^8.0.0",
 "ws": "^8.18.0"
 },
 "peerDependencies": {
 "zod": "^4.1.5"
 },
 "resolutions": {
 "strip-ansi": "6.0.1"
 }
}
}

4 changes: 2 additions & 2 deletions
src/examples/server/simpleSseServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
 count: z.number().describe('Number of notifications to send').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStatelessStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/sseAndStreamableHttpCompatibleServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

2 changes: 1 addition & 1 deletion
src/integration-tests/stateManagementStreamableHttp.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
 'greet',
 'A simple greeting tool',
 {
 name: z.string().describe('Name to greet').default('World'),
 name: z.string().describe('Name to greet').prefault('World'),
 },
 async ({ name }) => {
 return {
Expand Down

6 changes: 3 additions & 3 deletions
src/integration-tests/taskResumability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
 'send-notification',
 'Sends a single notification',
 {
 message: z.string().describe('Message to send').default('Test notification')
 message: z.string().describe('Message to send').prefault('Test notification')
 },
 async ({ message }, { sendNotification }) => {
 // Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
 'run-notifications',
 'Sends multiple notifications over time',
 {
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval between notifications in ms').default(50)
 count: z.number().describe('Number of notifications to send').prefault(10),
 interval: z.number().describe('Interval between notifications in ms').prefault(50)
 },
 async ({ count, interval }, { sendNotification }) => {
 // Send notifications at specified intervals
Expand Down

6 changes: 4 additions & 2 deletions
src/server/auth/handlers/authorize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
 client_id: z.string(),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
 error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
 code_challenge_method: z.literal("S256"),
 scope: z.string().optional(),
 state: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down

4 changes: 2 additions & 2 deletions
src/server/auth/handlers/token.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
 code: z.string(),
 code_verifier: z.string(),
 redirect_uri: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
 refresh_token: z.string(),
 scope: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down

12 changes: 7 additions & 5 deletions
src/server/completable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("allows async completion functions", async () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), async () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("passes current value to completion function", async () => {
 const schema = completable(z.string(), (value) => [value + "!"]);

 expect(await schema._def.complete("test")).toEqual(["test!"]);
 expect(await schema.def.complete("test")).toEqual(["test!"]);
 });

 it("works with number schemas", async () => {
 const schema = completable(z.number(), () => [1, 2, 3]);

 expect(schema.parse(1)).toBe(1);
 expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
 expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
 });

 it("preserves schema description", () => {
 // This is no longer how zod behavior works
 // See: https://github.com/colinhacks/zod/issues/4965
 it.skip("preserves schema description", () => {
 const desc = "test description";
 const schema = completable(z.string().describe(desc), () => []);

Expand Down

133 changes: 53 additions & 80 deletions
src/server/completable.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
 ZodTypeAny,
 ZodTypeDef,
 ZodType,
 ParseInput,
 ParseReturnType,
 RawCreateParams,
 ZodErrorMap,
 ProcessedCreateParams,
 z,
} from "zod";

export enum McpZodTypeKind {
 Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
 value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
 value: z.input<T>,
 context?: {
 arguments?: Record<string, string>;
 },
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
 complete: CompleteCallback<T>;
 typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
 T["_output"],
 CompletableDef<T>,
 T["_input"]
> {
 _parse(input: ParseInput): ParseReturnType<this["_output"]> {
 const { ctx } = this._processInputParams(input);
 const data = ctx.data;
 return this._def.type._parse({
 data,
 path: ctx.path,
 parent: ctx,
 });
 }
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
 extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
 def: $CompletableDef<T>;
 isst: never;
 /** Auto-cached way to retrieve the inner schema */
 innerType: T;
 pattern: T["_zod"]["pattern"];
 propValues: T["_zod"]["propValues"];
 optin: T["_zod"]["optin"];
 optout: T["_zod"]["optout"];
}

 unwrap() {
 return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

 static create = <T extends ZodTypeAny>(
 type: T,
 params: RawCreateParams & {
 complete: CompleteCallback<T>;
 },
 ): Completable<T> => {
 return new Completable({
 type,
 typeName: McpZodTypeKind.Completable,
 complete: params.complete,
 ...processCreateParams(params),
 });
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
 z.core.$ZodType.init(inst, def);

 z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
 z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
 z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
 z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
 z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

 inst._zod.parse = (payload, ctx) => {
 return def.innerType._zod.run(payload, ctx);
 };
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
 extends z._ZodType<$CompletableInternals<T>>,
 $Completable<T> {
 complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
 $Completable.init(inst, def);
 z.ZodType.init(inst, def);

 inst.complete = def.complete;
});

/**
 * Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
 */
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
 schema: T,
 complete: CompleteCallback<T>,
): Completable<T> {
 return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
 if (!params) return {};
 const { errorMap, invalid_type_error, required_error, description } = params;
 if (errorMap && (invalid_type_error || required_error)) {
 throw new Error(
 `Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
 );
 }
 if (errorMap) return { errorMap: errorMap, description };
 const customMap: ZodErrorMap = (iss, ctx) => {
 const { message } = params;

 if (iss.code === "invalid_enum_value") {
 return { message: message ?? ctx.defaultError };
 }
 if (typeof ctx.data === "undefined") {
 return { message: message ?? required_error ?? ctx.defaultError };
 }
 if (iss.code !== "invalid_type") return { message: ctx.defaultError };
 return { message: message ?? invalid_type_error ?? ctx.defaultError };
 };
 return { errorMap: customMap, description };
}
 return new Completable({
 type: "custom",
 innerType: schema,
 complete: complete,
 }) as Completable<T>;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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

jake-danton
wants to merge
3
commits into

from

 Closed


Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema
#914
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e55c327

tests passing


jake-danton Sep 2, 2025
63930d5

Merge branch 'modelcontextprotocol:main' into zod-v4-v3


jake-danton Sep 2, 2025
b01ef0b

fixing linting


jake-danton Sep 2, 2025

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


23 changes: 8 additions & 15 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


9 changes: 5 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
 "express": "^5.0.1",
 "express-rate-limit": "^7.5.0",
 "pkce-challenge": "^5.0.0",
 "raw-body": "^3.0.0",
 "zod": "^3.23.8",
 "zod-to-json-schema": "^3.24.1"
 "raw-body": "^3.0.0"
 },
 "devDependencies": {
 "@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
 "typescript-eslint": "^8.0.0",
 "ws": "^8.18.0"
 },
 "peerDependencies": {
 "zod": "^4.1.5"
 },
 "resolutions": {
 "strip-ansi": "6.0.1"
 }
}
}

4 changes: 2 additions & 2 deletions
src/examples/server/simpleSseServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
 count: z.number().describe('Number of notifications to send').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStatelessStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/sseAndStreamableHttpCompatibleServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

2 changes: 1 addition & 1 deletion
src/integration-tests/stateManagementStreamableHttp.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
 'greet',
 'A simple greeting tool',
 {
 name: z.string().describe('Name to greet').default('World'),
 name: z.string().describe('Name to greet').prefault('World'),
 },
 async ({ name }) => {
 return {
Expand Down

6 changes: 3 additions & 3 deletions
src/integration-tests/taskResumability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
 'send-notification',
 'Sends a single notification',
 {
 message: z.string().describe('Message to send').default('Test notification')
 message: z.string().describe('Message to send').prefault('Test notification')
 },
 async ({ message }, { sendNotification }) => {
 // Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
 'run-notifications',
 'Sends multiple notifications over time',
 {
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval between notifications in ms').default(50)
 count: z.number().describe('Number of notifications to send').prefault(10),
 interval: z.number().describe('Interval between notifications in ms').prefault(50)
 },
 async ({ count, interval }, { sendNotification }) => {
 // Send notifications at specified intervals
Expand Down

6 changes: 4 additions & 2 deletions
src/server/auth/handlers/authorize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
 client_id: z.string(),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
 error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
 code_challenge_method: z.literal("S256"),
 scope: z.string().optional(),
 state: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down

4 changes: 2 additions & 2 deletions
src/server/auth/handlers/token.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
 code: z.string(),
 code_verifier: z.string(),
 redirect_uri: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
 refresh_token: z.string(),
 scope: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down

12 changes: 7 additions & 5 deletions
src/server/completable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("allows async completion functions", async () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), async () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("passes current value to completion function", async () => {
 const schema = completable(z.string(), (value) => [value + "!"]);

 expect(await schema._def.complete("test")).toEqual(["test!"]);
 expect(await schema.def.complete("test")).toEqual(["test!"]);
 });

 it("works with number schemas", async () => {
 const schema = completable(z.number(), () => [1, 2, 3]);

 expect(schema.parse(1)).toBe(1);
 expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
 expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
 });

 it("preserves schema description", () => {
 // This is no longer how zod behavior works
 // See: https://github.com/colinhacks/zod/issues/4965
 it.skip("preserves schema description", () => {
 const desc = "test description";
 const schema = completable(z.string().describe(desc), () => []);

Expand Down

133 changes: 53 additions & 80 deletions
src/server/completable.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
 ZodTypeAny,
 ZodTypeDef,
 ZodType,
 ParseInput,
 ParseReturnType,
 RawCreateParams,
 ZodErrorMap,
 ProcessedCreateParams,
 z,
} from "zod";

export enum McpZodTypeKind {
 Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
 value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
 value: z.input<T>,
 context?: {
 arguments?: Record<string, string>;
 },
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
 complete: CompleteCallback<T>;
 typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
 T["_output"],
 CompletableDef<T>,
 T["_input"]
> {
 _parse(input: ParseInput): ParseReturnType<this["_output"]> {
 const { ctx } = this._processInputParams(input);
 const data = ctx.data;
 return this._def.type._parse({
 data,
 path: ctx.path,
 parent: ctx,
 });
 }
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
 extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
 def: $CompletableDef<T>;
 isst: never;
 /** Auto-cached way to retrieve the inner schema */
 innerType: T;
 pattern: T["_zod"]["pattern"];
 propValues: T["_zod"]["propValues"];
 optin: T["_zod"]["optin"];
 optout: T["_zod"]["optout"];
}

 unwrap() {
 return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

 static create = <T extends ZodTypeAny>(
 type: T,
 params: RawCreateParams & {
 complete: CompleteCallback<T>;
 },
 ): Completable<T> => {
 return new Completable({
 type,
 typeName: McpZodTypeKind.Completable,
 complete: params.complete,
 ...processCreateParams(params),
 });
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
 z.core.$ZodType.init(inst, def);

 z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
 z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
 z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
 z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
 z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

 inst._zod.parse = (payload, ctx) => {
 return def.innerType._zod.run(payload, ctx);
 };
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
 extends z._ZodType<$CompletableInternals<T>>,
 $Completable<T> {
 complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
 $Completable.init(inst, def);
 z.ZodType.init(inst, def);

 inst.complete = def.complete;
});

/**
 * Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
 */
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
 schema: T,
 complete: CompleteCallback<T>,
): Completable<T> {
 return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
 if (!params) return {};
 const { errorMap, invalid_type_error, required_error, description } = params;
 if (errorMap && (invalid_type_error || required_error)) {
 throw new Error(
 `Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
 );
 }
 if (errorMap) return { errorMap: errorMap, description };
 const customMap: ZodErrorMap = (iss, ctx) => {
 const { message } = params;

 if (iss.code === "invalid_enum_value") {
 return { message: message ?? ctx.defaultError };
 }
 if (typeof ctx.data === "undefined") {
 return { message: message ?? required_error ?? ctx.defaultError };
 }
 if (iss.code !== "invalid_type") return { message: ctx.defaultError };
 return { message: message ?? invalid_type_error ?? ctx.defaultError };
 };
 return { errorMap: customMap, description };
}
 return new Completable({
 type: "custom",
 innerType: schema,
 complete: complete,
 }) as Completable<T>;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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

jake-danton
wants to merge
3
commits into

from

 Closed


Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema
#914
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e55c327

tests passing


jake-danton Sep 2, 2025
63930d5

Merge branch 'modelcontextprotocol:main' into zod-v4-v3


jake-danton Sep 2, 2025
b01ef0b

fixing linting


jake-danton Sep 2, 2025

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


23 changes: 8 additions & 15 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


9 changes: 5 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
 "express": "^5.0.1",
 "express-rate-limit": "^7.5.0",
 "pkce-challenge": "^5.0.0",
 "raw-body": "^3.0.0",
 "zod": "^3.23.8",
 "zod-to-json-schema": "^3.24.1"
 "raw-body": "^3.0.0"
 },
 "devDependencies": {
 "@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
 "typescript-eslint": "^8.0.0",
 "ws": "^8.18.0"
 },
 "peerDependencies": {
 "zod": "^4.1.5"
 },
 "resolutions": {
 "strip-ansi": "6.0.1"
 }
}
}

4 changes: 2 additions & 2 deletions
src/examples/server/simpleSseServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
 count: z.number().describe('Number of notifications to send').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStatelessStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/sseAndStreamableHttpCompatibleServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

2 changes: 1 addition & 1 deletion
src/integration-tests/stateManagementStreamableHttp.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
 'greet',
 'A simple greeting tool',
 {
 name: z.string().describe('Name to greet').default('World'),
 name: z.string().describe('Name to greet').prefault('World'),
 },
 async ({ name }) => {
 return {
Expand Down

6 changes: 3 additions & 3 deletions
src/integration-tests/taskResumability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
 'send-notification',
 'Sends a single notification',
 {
 message: z.string().describe('Message to send').default('Test notification')
 message: z.string().describe('Message to send').prefault('Test notification')
 },
 async ({ message }, { sendNotification }) => {
 // Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
 'run-notifications',
 'Sends multiple notifications over time',
 {
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval between notifications in ms').default(50)
 count: z.number().describe('Number of notifications to send').prefault(10),
 interval: z.number().describe('Interval between notifications in ms').prefault(50)
 },
 async ({ count, interval }, { sendNotification }) => {
 // Send notifications at specified intervals
Expand Down

6 changes: 4 additions & 2 deletions
src/server/auth/handlers/authorize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
 client_id: z.string(),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
 error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
 code_challenge_method: z.literal("S256"),
 scope: z.string().optional(),
 state: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down

4 changes: 2 additions & 2 deletions
src/server/auth/handlers/token.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
 code: z.string(),
 code_verifier: z.string(),
 redirect_uri: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
 refresh_token: z.string(),
 scope: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down

12 changes: 7 additions & 5 deletions
src/server/completable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("allows async completion functions", async () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), async () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("passes current value to completion function", async () => {
 const schema = completable(z.string(), (value) => [value + "!"]);

 expect(await schema._def.complete("test")).toEqual(["test!"]);
 expect(await schema.def.complete("test")).toEqual(["test!"]);
 });

 it("works with number schemas", async () => {
 const schema = completable(z.number(), () => [1, 2, 3]);

 expect(schema.parse(1)).toBe(1);
 expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
 expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
 });

 it("preserves schema description", () => {
 // This is no longer how zod behavior works
 // See: https://github.com/colinhacks/zod/issues/4965
 it.skip("preserves schema description", () => {
 const desc = "test description";
 const schema = completable(z.string().describe(desc), () => []);

Expand Down

133 changes: 53 additions & 80 deletions
src/server/completable.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
 ZodTypeAny,
 ZodTypeDef,
 ZodType,
 ParseInput,
 ParseReturnType,
 RawCreateParams,
 ZodErrorMap,
 ProcessedCreateParams,
 z,
} from "zod";

export enum McpZodTypeKind {
 Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
 value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
 value: z.input<T>,
 context?: {
 arguments?: Record<string, string>;
 },
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
 complete: CompleteCallback<T>;
 typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
 T["_output"],
 CompletableDef<T>,
 T["_input"]
> {
 _parse(input: ParseInput): ParseReturnType<this["_output"]> {
 const { ctx } = this._processInputParams(input);
 const data = ctx.data;
 return this._def.type._parse({
 data,
 path: ctx.path,
 parent: ctx,
 });
 }
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
 extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
 def: $CompletableDef<T>;
 isst: never;
 /** Auto-cached way to retrieve the inner schema */
 innerType: T;
 pattern: T["_zod"]["pattern"];
 propValues: T["_zod"]["propValues"];
 optin: T["_zod"]["optin"];
 optout: T["_zod"]["optout"];
}

 unwrap() {
 return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

 static create = <T extends ZodTypeAny>(
 type: T,
 params: RawCreateParams & {
 complete: CompleteCallback<T>;
 },
 ): Completable<T> => {
 return new Completable({
 type,
 typeName: McpZodTypeKind.Completable,
 complete: params.complete,
 ...processCreateParams(params),
 });
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
 z.core.$ZodType.init(inst, def);

 z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
 z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
 z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
 z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
 z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

 inst._zod.parse = (payload, ctx) => {
 return def.innerType._zod.run(payload, ctx);
 };
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
 extends z._ZodType<$CompletableInternals<T>>,
 $Completable<T> {
 complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
 $Completable.init(inst, def);
 z.ZodType.init(inst, def);

 inst.complete = def.complete;
});

/**
 * Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
 */
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
 schema: T,
 complete: CompleteCallback<T>,
): Completable<T> {
 return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
 if (!params) return {};
 const { errorMap, invalid_type_error, required_error, description } = params;
 if (errorMap && (invalid_type_error || required_error)) {
 throw new Error(
 `Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
 );
 }
 if (errorMap) return { errorMap: errorMap, description };
 const customMap: ZodErrorMap = (iss, ctx) => {
 const { message } = params;

 if (iss.code === "invalid_enum_value") {
 return { message: message ?? ctx.defaultError };
 }
 if (typeof ctx.data === "undefined") {
 return { message: message ?? required_error ?? ctx.defaultError };
 }
 if (iss.code !== "invalid_type") return { message: ctx.defaultError };
 return { message: message ?? invalid_type_error ?? ctx.defaultError };
 };
 return { errorMap: customMap, description };
}
 return new Completable({
 type: "custom",
 innerType: schema,
 complete: complete,
 }) as Completable<T>;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema#914

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

jake-danton
wants to merge
3
commits into

from

 Closed


Migrating to Zod v4, marking as peer dependency, and removing zod-to-json-schema
#914
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e55c327

tests passing


jake-danton Sep 2, 2025
63930d5

Merge branch 'modelcontextprotocol:main' into zod-v4-v3


jake-danton Sep 2, 2025
b01ef0b

fixing linting


jake-danton Sep 2, 2025

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


23 changes: 8 additions & 15 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


9 changes: 5 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,9 +71,7 @@
 "express": "^5.0.1",
 "express-rate-limit": "^7.5.0",
 "pkce-challenge": "^5.0.0",
 "raw-body": "^3.0.0",
 "zod": "^3.23.8",
 "zod-to-json-schema": "^3.24.1"
 "raw-body": "^3.0.0"
 },
 "devDependencies": {
 "@eslint/js": "^9.8.0",
Expand All@@ -97,7 +95,10 @@
 "typescript-eslint": "^8.0.0",
 "ws": "^8.18.0"
 },
 "peerDependencies": {
 "zod": "^4.1.5"
 },
 "resolutions": {
 "strip-ansi": "6.0.1"
 }
}
}

4 changes: 2 additions & 2 deletions
src/examples/server/simpleSseServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(1000),
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(1000),
 count: z.number().describe('Number of notifications to send').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStatelessStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,8 +39,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(10),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(10),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/simpleStreamableHttp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -270,8 +270,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

4 changes: 2 additions & 2 deletions
src/examples/server/sseAndStreamableHttpCompatibleServer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,8 +30,8 @@ const getServer = () => {
 'start-notification-stream',
 'Starts sending periodic notifications for testing resumability',
 {
 interval: z.number().describe('Interval in milliseconds between notifications').default(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').default(50),
 interval: z.number().describe('Interval in milliseconds between notifications').prefault(100),
 count: z.number().describe('Number of notifications to send (0 for 100)').prefault(50),
 },
 async ({ interval, count }, extra): Promise<CallToolResult> => {
 const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
Expand Down

2 changes: 1 addition & 1 deletion
src/integration-tests/stateManagementStreamableHttp.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe('Streamable HTTP Transport Session Management', () => {
 'greet',
 'A simple greeting tool',
 {
 name: z.string().describe('Name to greet').default('World'),
 name: z.string().describe('Name to greet').prefault('World'),
 },
 async ({ name }) => {
 return {
Expand Down

6 changes: 3 additions & 3 deletions
src/integration-tests/taskResumability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ describe('Transport resumability', () => {
 'send-notification',
 'Sends a single notification',
 {
 message: z.string().describe('Message to send').default('Test notification')
 message: z.string().describe('Message to send').prefault('Test notification')
 },
 async ({ message }, { sendNotification }) => {
 // Send notification immediately
Expand All@@ -56,8 +56,8 @@ describe('Transport resumability', () => {
 'run-notifications',
 'Sends multiple notifications over time',
 {
 count: z.number().describe('Number of notifications to send').default(10),
 interval: z.number().describe('Interval between notifications in ms').default(50)
 count: z.number().describe('Number of notifications to send').prefault(10),
 interval: z.number().describe('Interval between notifications in ms').prefault(50)
 },
 async ({ count, interval }, { sendNotification }) => {
 // Send notifications at specified intervals
Expand Down

6 changes: 4 additions & 2 deletions
src/server/auth/handlers/authorize.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,9 @@ export type AuthorizationHandlerOptions = {
// Parameters that must be validated in order to issue redirects.
const ClientAuthorizationParamsSchema = z.object({
 client_id: z.string(),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), { message: "redirect_uri must be a valid URL" }),
 redirect_uri: z.string().optional().refine((value) => value === undefined || URL.canParse(value), {
 error: "redirect_uri must be a valid URL"
}),
});

// Parameters that must be validated for a successful authorization request. Failure can be reported to the redirect URI.
Expand All@@ -35,7 +37,7 @@ const RequestAuthorizationParamsSchema = z.object({
 code_challenge_method: z.literal("S256"),
 scope: z.string().optional(),
 state: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function authorizationHandler({ provider, rateLimit: rateLimitConfig }: AuthorizationHandlerOptions): RequestHandler {
Expand Down

4 changes: 2 additions & 2 deletions
src/server/auth/handlers/token.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,13 +32,13 @@ const AuthorizationCodeGrantSchema = z.object({
 code: z.string(),
 code_verifier: z.string(),
 redirect_uri: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

const RefreshTokenGrantSchema = z.object({
 refresh_token: z.string(),
 scope: z.string().optional(),
 resource: z.string().url().optional(),
 resource: z.url().optional(),
});

export function tokenHandler({ provider, rateLimit: rateLimitConfig }: TokenHandlerOptions): RequestHandler {
Expand Down

12 changes: 7 additions & 5 deletions
src/server/completable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,30 +14,32 @@ describe("completable", () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("allows async completion functions", async () => {
 const completions = ["foo", "bar", "baz"];
 const schema = completable(z.string(), async () => completions);

 expect(await schema._def.complete("")).toEqual(completions);
 expect(await schema.def.complete("")).toEqual(completions);
 });

 it("passes current value to completion function", async () => {
 const schema = completable(z.string(), (value) => [value + "!"]);

 expect(await schema._def.complete("test")).toEqual(["test!"]);
 expect(await schema.def.complete("test")).toEqual(["test!"]);
 });

 it("works with number schemas", async () => {
 const schema = completable(z.number(), () => [1, 2, 3]);

 expect(schema.parse(1)).toBe(1);
 expect(await schema._def.complete(0)).toEqual([1, 2, 3]);
 expect(await schema.def.complete(0)).toEqual([1, 2, 3]);
 });

 it("preserves schema description", () => {
 // This is no longer how zod behavior works
 // See: https://github.com/colinhacks/zod/issues/4965
 it.skip("preserves schema description", () => {
 const desc = "test description";
 const schema = completable(z.string().describe(desc), () => []);

Expand Down

133 changes: 53 additions & 80 deletions
src/server/completable.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,98 +1,71 @@
import {
 ZodTypeAny,
 ZodTypeDef,
 ZodType,
 ParseInput,
 ParseReturnType,
 RawCreateParams,
 ZodErrorMap,
 ProcessedCreateParams,
 z,
} from "zod";

export enum McpZodTypeKind {
 Completable = "McpCompletable",
}

export type CompleteCallback<T extends ZodTypeAny = ZodTypeAny> = (
 value: T["_input"],
export type CompleteCallback<T extends z.core.SomeType = z.core.SomeType> = (
 value: z.input<T>,
 context?: {
 arguments?: Record<string, string>;
 },
) => T["_input"][] | Promise<T["_input"][]>;
) => z.output<T>[] | Promise<z.output<T>[]>;

export interface CompletableDef<T extends ZodTypeAny = ZodTypeAny>
extends ZodTypeDef {
type: T;
export interface $CompletableDef<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodTypeDef {
type: "custom";
innerType: T;
 complete: CompleteCallback<T>;
 typeName: McpZodTypeKind.Completable;
}

export class Completable<T extends ZodTypeAny> extends ZodType<
 T["_output"],
 CompletableDef<T>,
 T["_input"]
> {
 _parse(input: ParseInput): ParseReturnType<this["_output"]> {
 const { ctx } = this._processInputParams(input);
 const data = ctx.data;
 return this._def.type._parse({
 data,
 path: ctx.path,
 parent: ctx,
 });
 }
export interface $CompletableInternals<T extends z.core.SomeType = z.core.$ZodType>
 extends z.core.$ZodTypeInternals<z.core.output<T>, z.core.input<T>> {
 def: $CompletableDef<T>;
 isst: never;
 /** Auto-cached way to retrieve the inner schema */
 innerType: T;
 pattern: T["_zod"]["pattern"];
 propValues: T["_zod"]["propValues"];
 optin: T["_zod"]["optin"];
 optout: T["_zod"]["optout"];
}

 unwrap() {
 return this._def.type;
}
export interface $Completable<T extends z.core.SomeType = z.core.$ZodType> extends z.core.$ZodType {
_zod: $CompletableInternals<T>;
}

 static create = <T extends ZodTypeAny>(
 type: T,
 params: RawCreateParams & {
 complete: CompleteCallback<T>;
 },
 ): Completable<T> => {
 return new Completable({
 type,
 typeName: McpZodTypeKind.Completable,
 complete: params.complete,
 ...processCreateParams(params),
 });
export const $Completable: z.core.$constructor<$Completable> = /*@__PURE__*/ z.core.$constructor("$Completable", (inst, def) => {
 z.core.$ZodType.init(inst, def);

 z.util.defineLazy(inst._zod, "innerType", () => inst._zod.innerType);
 z.util.defineLazy(inst._zod, "pattern", () => inst._zod.innerType._zod.pattern);
 z.util.defineLazy(inst._zod, "propValues", () => inst._zod.innerType._zod.propValues);
 z.util.defineLazy(inst._zod, "optin", () => inst._zod.innerType._zod.optin ?? undefined);
 z.util.defineLazy(inst._zod, "optout", () => inst._zod.innerType._zod.optout ?? undefined);

 inst._zod.parse = (payload, ctx) => {
 return def.innerType._zod.run(payload, ctx);
 };
});


// Completable
export interface Completable<T extends z.core.SomeType = z.core.$ZodType>
 extends z._ZodType<$CompletableInternals<T>>,
 $Completable<T> {
 complete: CompleteCallback<T>;
}
export const Completable: z.core.$constructor<Completable> = /*@__PURE__*/ z.core.$constructor("Completable", (inst, def) => {
 $Completable.init(inst, def);
 z.ZodType.init(inst, def);

 inst.complete = def.complete;
});

/**
 * Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
 */
export function completable<T extends ZodTypeAny>(
export function completable<T extends z.ZodType>(
 schema: T,
 complete: CompleteCallback<T>,
): Completable<T> {
 return Completable.create(schema, { ...schema._def, complete });
}

// Not sure why this isn't exported from Zod:
// https://github.com/colinhacks/zod/blob/f7ad26147ba291cb3fb257545972a8e00e767470/src/types.ts#L130
function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
 if (!params) return {};
 const { errorMap, invalid_type_error, required_error, description } = params;
 if (errorMap && (invalid_type_error || required_error)) {
 throw new Error(
 `Can't use "invalid_type_error" or "required_error" in conjunction with custom error map.`,
 );
 }
 if (errorMap) return { errorMap: errorMap, description };
 const customMap: ZodErrorMap = (iss, ctx) => {
 const { message } = params;

 if (iss.code === "invalid_enum_value") {
 return { message: message ?? ctx.defaultError };
 }
 if (typeof ctx.data === "undefined") {
 return { message: message ?? required_error ?? ctx.defaultError };
 }
 if (iss.code !== "invalid_type") return { message: ctx.defaultError };
 return { message: message ?? invalid_type_error ?? ctx.defaultError };
 };
 return { errorMap: customMap, description };
}
 return new Completable({
 type: "custom",
 innerType: schema,
 complete: complete,
 }) as Completable<T>;
}
Loading