Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions src/server/completable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,13 @@ export class Completable<T extends ZodTypeAny> extends ZodType<
};
}

// Runtime type guard to detect Completable-wrapped Zod types across versions
export function isCompletable<T extends ZodTypeAny = ZodTypeAny>(value: unknown): value is Completable<T> {
if (value === null || typeof value !== "object") return false;
const obj = value as { _def?: { typeName?: unknown } };
return obj._def?.typeName === McpZodTypeKind.Completable;
}

/**
* Wraps a Zod type to provide autocompletion capabilities. Useful for, e.g., prompt arguments in MCP.
*/
Expand Down
84 changes: 84 additions & 0 deletions src/server/mcp.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2479,6 +2479,47 @@ describe("resource()", () => {
).rejects.toThrow(/Resource test:\/\/nonexistent not found/);
});


/***
* Test: Registering a resource template without a complete callback should not update server capabilities to advertise support for completion
*/
test("should not advertise support for completion when a resource template without a complete callback is defined", async () => {
const mcpServer = new McpServer({
name: "test server",
version: "1.0",
});
const client = new Client({
name: "test client",
version: "1.0",
});

mcpServer.resource(
"test",
new ResourceTemplate("test://resource/{category}", {
list: undefined,
}),
async () => ({
contents: [
{
uri: "test://resource/test",
text: "Test content",
},
],
}),
);

const [clientTransport, serverTransport] =
InMemoryTransport.createLinkedPair();

await Promise.all([
client.connect(clientTransport),
mcpServer.server.connect(serverTransport),
]);

expect(client.getServerCapabilities()).not.toMatchObject({ completions: {} })
})


/***
* Test: Registering a resource template with a complete callback should update server capabilities to advertise support for completion
*/
Expand Down Expand Up @@ -3440,6 +3481,49 @@ describe("prompt()", () => {
expect(client.getServerCapabilities()).toMatchObject({ completions: {} })
})


/***
* Test: Registering a prompt without a completable argument should not update server capabilities to advertise support for completion
*/
test("should not advertise support for completion when a prompt without a completable argument is defined", async () => {
const mcpServer = new McpServer({
name: "test server",
version: "1.0",
});
const client = new Client({
name: "test client",
version: "1.0",
});

mcpServer.prompt(
"test-prompt",
{
name: z.string()
},
async ({ name }) => ({
messages: [
{
role: "assistant",
content: {
type: "text",
text: `Hello ${name}`,
},
},
],
}),
);

const [clientTransport, serverTransport] =
InMemoryTransport.createLinkedPair();

await Promise.all([
client.connect(clientTransport),
mcpServer.server.connect(serverTransport),
]);

expect(client.getServerCapabilities()).not.toMatchObject({ completions: {} })
})

/***
* Test: Prompt Argument Completion
*/
Expand Down
28 changes: 22 additions & 6 deletions src/server/mcp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import {
ToolAnnotations,
LoggingMessageNotification,
} from "../types.js";
import { Completable, CompletableDef } from "./completable.js";
import { CompletableDef, isCompletable } from "./completable.js";
import { UriTemplate, Variables } from "../shared/uriTemplate.js";
import { RequestHandlerExtra } from "../shared/protocol.js";
import { Transport } from "../shared/transport.js";
Expand Down Expand Up @@ -290,7 +290,7 @@ export class McpServer {
}

const field = prompt.argsSchema.shape[request.params.argument.name];
if (!(field instanceof Completable)) {
if (!isCompletable<ZodString>(field)) {
return EMPTY_COMPLETION_RESULT;
}

Expand Down Expand Up @@ -439,8 +439,6 @@ export class McpServer {
},
);

this.setCompletionRequestHandler();

this._resourceHandlersInitialized = true;
}

Expand Down Expand Up @@ -523,8 +521,6 @@ export class McpServer {
},
);

this.setCompletionRequestHandler();

this._promptHandlersInitialized = true;
}

Expand Down Expand Up @@ -731,6 +727,14 @@ export class McpServer {
},
};
this._registeredResourceTemplates[name] = registeredResourceTemplate;

// If the resource template has any completion callbacks, enable completions capability
const variableNames = template.uriTemplate.variableNames;
const hasCompleter = Array.isArray(variableNames) && variableNames.some((v) => !!template.completeCallback(v));
if (hasCompleter) {
this.setCompletionRequestHandler();
}

return registeredResourceTemplate;
}

Expand Down Expand Up @@ -764,6 +768,18 @@ export class McpServer {
},
};
this._registeredPrompts[name] = registeredPrompt;

// If any argument uses a Completable schema, enable completions capability
if (argsSchema) {
const hasCompletable = Object.values(argsSchema).some((field) => {
const inner: unknown = field instanceof ZodOptional ? field._def?.innerType : field;
return isCompletable(inner);
});
if (hasCompletable) {
this.setCompletionRequestHandler();
}
}

return registeredPrompt;
}

Expand Down