@modelcontextprotocol/sdk
    Preparing search index...

    Interface ElicitRequest

    A request from the server to elicit additional information from the user via the client.

    interface ElicitRequest {
        id: RequestId;
        jsonrpc: "2.0";
        method: "elicitation/create";
        params: {
            message: string;
            requestedSchema: {
                properties: { [key: string]: PrimitiveSchemaDefinition };
                required?: string[];
                type: "object";
            };
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    id jsonrpc method params

    Properties

    id: RequestId
    jsonrpc: "2.0"
    method: "elicitation/create"
    params: {
        message: string;
        requestedSchema: {
            properties: { [key: string]: PrimitiveSchemaDefinition };
            required?: string[];
            type: "object";
        };
    }

    Type Declaration

    • 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