MCP PHP SDK

TitledEnumSchemaDefinition extends AbstractSchemaDefinition

FinalYes

Schema definition for single-select enum fields with titled options (SEP-1330).

Uses the oneOf pattern with const/title pairs instead of enum/enumNames. Produces: {"type": "string", "oneOf": [{"const": "value", "title": "Label"}, ...]}

Tags
see
https://github.com/modelcontextprotocol/modelcontextprotocol/issues/1330

Table of Contents

Properties

$default  : string|null
$description  : string|null
$oneOf  : array<int, array{const: string, title: string}>
$title  : string|null

Methods

__construct()  : mixed
fromArray()  : self
getDefault()  : string|null
The value the field is pre-filled with, or null when it declares none.
jsonSerialize()  : array<string, mixed>
buildBaseJson()  : array{type: string, title?: string, description?: string}
Build the base JSON structure with type, optional title and description.
validateTitle()  : void
Reject a title that is present but not a string.

Properties

Methods

__construct()

public __construct(string|null $title, array<string|int, mixed> $oneOf[, string|null $description = null ][, string|null $default = null ]) : mixed
Parameters
$title : string|null

Optional human-readable title for the field

$oneOf : array<string|int, mixed>

Array of const/title pairs

$description : string|null = null

Optional description/help text

$default : string|null = null

Optional default value (must match a const)

fromArray()

public static fromArray(array{title?: string, oneOf: list, description?: string, default?: string}|array<string|int, mixed> $data) : self
Parameters
$data : array{title?: string, oneOf: list, description?: string, default?: string}|array<string|int, mixed>
Return values
self

getDefault()

The value the field is pre-filled with, or null when it declares none.

public getDefault() : string|null
Return values
string|null

buildBaseJson()

Build the base JSON structure with type, optional title and description.

protected buildBaseJson(string $type) : array{type: string, title?: string, description?: string}
Parameters
$type : string
Return values
array{type: string, title?: string, description?: string}

validateTitle()

Reject a title that is present but not a string.

protected static validateTitle(array<string, mixed> $data, string $schemaType) : void
Parameters
$data : array<string, mixed>
$schemaType : string
Tags
throws
InvalidArgumentException
On this page

Search results