orionis.mcp.McpResponse

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class McpResponse: (source)

View In Hierarchy

Compose protocol content without knowing the transport or DI container.

Class Method	`audio`	Encode raw audio bytes once.
Class Method	`error`	Return an application-visible tool error, with an explicit safe message.
Class Method	`image`	Encode raw image bytes once.
Class Method	`progress`	Yield progress; the dispatcher suppresses it without client opt-in.
Class Method	`resource`	Embed text or binary resource content at an explicit URI.
Class Method	`resourceLink`	Link to a resource without loading it.
Class Method	`structured`	Return any JSON value and the recommended serialized text content.
Class Method	`text`	Return text content.
Method	`asAssistant`	Assign the assistant role for a prompt response.
Method	`asUser`	Assign the user role for a prompt response.
Method	`withAnnotations`	Set audience, priority and modification hints on content blocks.
Method	`withContentMeta`	Attach application metadata to each content block.
Method	`withMeta`	Attach result metadata without allowing reserved protocol keys.
Class Variable	`content`	Undocumented
Class Variable	`is_error`	Undocumented
Class Variable	`meta`	Undocumented
Class Variable	`progress_update`	Undocumented
Class Variable	`role`	Undocumented

@classmethod

def audio(cls, value: bytes, mime_type: str) -> Self: (source) ¶

Encode raw audio bytes once.

Parameters
value:`bytes`	Value to inspect, transform or validate.
mime_type:`str`	Value supplied for `mime_type`.

Returns
`Self`	Result of the operation described above.

@classmethod

def error(cls, message: str) -> Self: (source) ¶

Return an application-visible tool error, with an explicit safe message.

Parameters
message:`str`	Value supplied for `message`.

Returns
`Self`	An application-visible tool error, with an explicit safe message.

@classmethod

def image(cls, value: bytes, mime_type: str) -> Self: (source) ¶

Encode raw image bytes once.

Parameters
value:`bytes`	Value to inspect, transform or validate.
mime_type:`str`	Value supplied for `mime_type`.

Returns
`Self`	Result of the operation described above.

@classmethod

def progress(cls, current: float, total: float | None = None, message: str | None = None) -> Self: (source) ¶

Yield progress; the dispatcher suppresses it without client opt-in.

Parameters
current:`float`	Value supplied for `current`.
total:`float \| None`	Value supplied for `total`.
message:`str \| None`	Value supplied for `message`.

Returns
`Self`	Result of the operation described above.

@classmethod

def resource(cls, uri: str, value: str | bytes, mime_type: str | None = None) -> Self: (source) ¶

Embed text or binary resource content at an explicit URI.

Parameters
uri:`str`	Value supplied for `uri`.
value:`str \| bytes`	Value to inspect, transform or validate.
mime_type:`str \| None`	Value supplied for `mime_type`.

Returns
`Self`	Result of the operation described above.

@classmethod

def resourceLink(cls, uri: str, name: str, *, title: str | None = None, description: str | None = None, mime_type: str | None = None) -> Self: (source) ¶

Link to a resource without loading it.

Parameters
uri:`str`	Value supplied for `uri`.
name:`str`	Value supplied for `name`.
title:`str \| None`	Value supplied for `title`.
description:`str \| None`	Value supplied for `description`.
mime_type:`str \| None`	Value supplied for `mime_type`.

Returns
`Self`	Result of the operation described above.

@classmethod

def structured(cls, value: object) -> Self: (source) ¶

Return any JSON value and the recommended serialized text content.

Parameters
value:`object`	Value to inspect, transform or validate.

Returns
`Self`	Any JSON value and the recommended serialized text content.

@classmethod

def text(cls, value: str) -> Self: (source) ¶

Return text content.

Parameters
value:`str`	Value to inspect, transform or validate.

Returns
`Self`	Text content.

def asAssistant(self) -> Self: (source) ¶

Assign the assistant role for a prompt response.

Returns
`Self`	Result of the operation described above.

def asUser(self) -> Self: (source) ¶

Assign the user role for a prompt response.

Returns
`Self`	Result of the operation described above.

def withAnnotations(self, annotations: ContentAnnotations) -> Self: (source) ¶

Set audience, priority and modification hints on content blocks.

Parameters
annotations:`ContentAnnotations`	Value supplied for `annotations`.

Returns
`Self`	Result of the operation described above.

def withContentMeta(self, metadata: dict[str, object]) -> Self: (source) ¶

Attach application metadata to each content block.

Parameters
metadata:`dict[str, object]`	Metadata associated with the current operation.

Returns
`Self`	Result of the operation described above.

def withMeta(self, metadata: dict[str, object]) -> Self: (source) ¶

Attach result metadata without allowing reserved protocol keys.

Parameters
metadata:`dict[str, object]`	Metadata associated with the current operation.

Returns
`Self`	Result of the operation described above.

content: tuple[ContentBlock, ...] = (source) ¶

Undocumented

is_error: bool = (source) ¶

Undocumented

meta: dict[str, object] = (source) ¶

Undocumented

progress_update: Progress | None = (source) ¶

Undocumented

role: Literal['user', 'assistant'] = (source) ¶

Undocumented