mcp-use TypeScript API
    Preparing search index...

    Interface SettingsField<Schema>

    Native primitive setting and its presentation metadata.

    interface SettingsField<
        Schema extends StandardSchemaWithJSON = StandardSchemaWithJSON,
    > {
        description?: string;
        schema: Schema;
        title: string;
    }

    Type Parameters

    • Schema extends StandardSchemaWithJSON = StandardSchemaWithJSON
    Index
    description? schema title
    description?: string

    Optional explanatory text displayed by the host.

    schema: Schema

    Primitive Standard Schema with JSON Schema conversion; read() returns effective values. Validation must preserve supplied values; value-changing transforms are rejected at runtime.

    title: string

    Non-blank label displayed by the host.

    Settings
    Member Visibility

    On This Page
    Properties