ToolResult

Structured result from tool execution. All tools should return ToolResult for consistent rendering across channels.

public function __construct(bool $success, ?mixed $data = null, ?string $message = null, ?string $error = null, array $meta = []):

Parameters

public static function success(?mixed $data = null, ?string $message = null, array $meta = []): self

Create a success result.

Parameters

public static function error(string $error, ?mixed $data = null, array $meta = []): self

Create an error result.

Parameters

public static function paginated(array $items, int $page, int $totalItems, int $limit, ?string $message = null, array $extraMeta = []): self

Create a paginated list result.

Parameters

public static function detail(array $item, string $entity, ?string $message = null, array $actions = []): self

Create a detail/single item result.

Parameters

public static function confirmation(string $message, array $details, string $action, string $target, string|int $targetId): self

Create a confirmation request result.

Parameters

public static function blocked(string $reason, ?string $suggestion = null): self

Create a blocked result (by business rule).

Parameters

public function requiresConfirmation(): bool

Check if this result requires confirmation.

public function isBlocked(): bool

Check if this result was blocked by a business rule.

public function getType(): string

Get the result type.

public function getPagination(): ?array

Get pagination info if present.

public function getActions(): array

Get actions if present.

public function getConfirmToken(): ?string

Get the confirmation token, if this result carries a confirmation request.

public function withMeta(array $extra): self

Return a copy with extra metadata merged into meta. Replaces the former ToolResult(A)::withMetadata(); the runtime uses it to attach soft-timeout info without rebuilding the result.

Parameters

public function jsonSerialize(): array

Serialize to the wire shape consumed by every channel renderer and the MCP transport.

public function toJson(): string

Encode this result as pretty-printed, unescaped-unicode JSON.

public function toArray(): array

Convert to a plain array; same shape as {@see jsonSerialize()}.