modelcontextprotocol/typescript-sdk
Watch
1
0
Fork
You've already forked typescript-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

fix: React to upstream RC schema changes for form mode elicitation requests (#1164)

Browse source 
Co-authored-by: Nate Barbettini <nate@arcade.dev>
This commit is contained in:
Felix Weinberger 2025-11-25 11:21:07 +00:00 • committed by GitHub
commit b59a2bde7d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 91 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/server/index.test.ts
View file

@ -700,7 +700,7 @@ test('should include form mode when sending elicitation form requests', async ()
const receivedModes: string[] = [];
client.setRequestHandler(ElicitRequestSchema, request => {
receivedModes.push(request.params.mode);
receivedModes.push(request.params.mode ?? '');
return {
action: 'accept',
content: {
@ -764,7 +764,7 @@ test('should include url mode when sending elicitation URL requests', async () =
const receivedModes: string[] = [];
const receivedIds: string[] = [];
client.setRequestHandler(ElicitRequestSchema, request => {
receivedModes.push(request.params.mode);
receivedModes.push(request.params.mode ?? '');
if (request.params.mode === 'url') {
receivedIds.push(request.params.elicitationId);
}

35
src/server/index.ts
View file

@ -37,8 +37,6 @@ import {
import { AjvJsonSchemaValidator } from '../validation/ajv-provider.js';
import type { JsonSchemaType, jsonSchemaValidator } from '../validation/types.js';
type LegacyElicitRequestFormParams = Omit<ElicitRequestFormParams, 'mode'>;
export type ServerOptions = ProtocolOptions & {
/**
* Capabilities to advertise as being supported by this server.
@ -375,33 +373,13 @@ export class Server<
/**
* Creates an elicitation request for the given parameters.
* @param params The parameters for the form elicitation request (explicit mode: 'form').
* For backwards compatibility, `mode` may be omitted for form requests and will default to `'form'`.
* @param params The parameters for the elicitation request.
* @param options Optional request options.
* @returns The result of the elicitation request.
*/
async elicitInput(params: ElicitRequestFormParams, options?: RequestOptions): Promise<ElicitResult>;
/**
* Creates an elicitation request for the given parameters.
* @param params The parameters for the URL elicitation request (with url and elicitationId).
* @param options Optional request options.
* @returns The result of the elicitation request.
*/
async elicitInput(params: ElicitRequestURLParams, options?: RequestOptions): Promise<ElicitResult>;
/**
* Creates an elicitation request for the given parameters.
* @deprecated Use the overloads with explicit `mode: 'form' | 'url'` instead.
* @param params The parameters for the form elicitation request (legacy signature without mode).
* @param options Optional request options.
* @returns The result of the elicitation request.
*/
async elicitInput(params: LegacyElicitRequestFormParams, options?: RequestOptions): Promise<ElicitResult>;
// Implementation (not visible to callers)
async elicitInput(
params: LegacyElicitRequestFormParams | ElicitRequestFormParams | ElicitRequestURLParams,
options?: RequestOptions
): Promise<ElicitResult> {
const mode = ('mode' in params ? params.mode : 'form') as 'form' | 'url';
async elicitInput(params: ElicitRequestFormParams | ElicitRequestURLParams, options?: RequestOptions): Promise<ElicitResult> {
const mode = (params.mode ?? 'form') as 'form' | 'url';
switch (mode) {
case 'url': {
@ -416,10 +394,9 @@ export class Server<
if (!this._clientCapabilities?.elicitation?.form) {
throw new Error('Client does not support form elicitation.');
}
const formParams: ElicitRequestFormParams =
'mode' in params
? (params as ElicitRequestFormParams)
: ({ ...(params as LegacyElicitRequestFormParams), mode: 'form' } as ElicitRequestFormParams);
params.mode === 'form' ? (params as ElicitRequestFormParams) : { ...(params as ElicitRequestFormParams), mode: 'form' };
const result = await this.request({ method: 'elicitation/create', params: formParams }, ElicitResultSchema, options);