@modelcontextprotocol/sdk
    Preparing search index...

    Interface ElicitRequestParams

    Parameters for an elicitation/create request.

    interface ElicitRequestParams {
        _meta?: { progressToken?: ProgressToken; [key: string]: unknown };
        message: string;
        requestedSchema: {
            properties: { [key: string]: PrimitiveSchemaDefinition };
            required?: string[];
            type: "object";
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    _meta? message requestedSchema

    Properties

    Optional_meta

    _meta?: { progressToken?: ProgressToken; [key: string]: unknown }

    See General fields: _meta for notes on _meta usage.

    Type Declaration

    • [key: string]: unknown
    • OptionalprogressToken?: ProgressToken

      If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.

    message: string

    The message to present to the user.

    requestedSchema: {
        properties: { [key: string]: PrimitiveSchemaDefinition };
        required?: string[];
        type: "object";
    }

    A restricted subset of JSON Schema. Only top-level properties are allowed, without nesting.

    Settings

    Member Visibility

    On This Page

    Properties