ORIONIS API REFERENCE

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.

module documentation

Describe MCP response cache lifetime and visibility options.

Class CacheOptions Describe MCP response cache lifetime and visibility options.
Function _metadata Merge response metadata while rejecting conflicting result values.
Function buffered_size Measure buffered JSON data without counting builder-only ownership state.
Function progress_params Enforce monotonic progress and retain the caller's correlation token.
Function prompt_result Preserve role and individual content-block boundaries.
Function resource_result Use only text/blob contents permitted by resources/read.
Function response_items Accept explicit content responses and reject accidental arbitrary objects.
Async Function tool_result Validate structured output before publishing a successful result.
Async Function validated_output Normalize declared structured output before publishing its wire value.
def _metadata(responses: tuple[McpResponse, ...]) -> dict[str, object]: (source)

Merge response metadata while rejecting conflicting result values.

Parameters
responses:tuple[orionis.mcp.McpResponse, ...]Value supplied for responses.
Returns
dict[str, object]Result of the operation described above.
def buffered_size(value: object) -> int: (source)

Measure buffered JSON data without counting builder-only ownership state.

Parameters
value:objectYielded response or typed protocol result.
Returns
intSerialized data size for early buffer admission. Final wire encoding separately enforces the complete response budget.
def progress_params(update: Progress, token: str | int, previous: float) -> dict[str, object]: (source)

Enforce monotonic progress and retain the caller's correlation token.

Parameters
update:orionis.mcp.responses.ProgressValue supplied for update.
token:str | intValue supplied for token.
previous:floatValue supplied for previous.
Returns
dict[str, object]Result of the operation described above.
def prompt_result(description: str, responses: tuple[McpResponse, ...]) -> GetPromptResult: (source)

Preserve role and individual content-block boundaries.

Parameters
description:strValue supplied for description.
responses:tuple[orionis.mcp.McpResponse, ...]Value supplied for responses.
Returns
orionis.mcp.protocol.results.GetPromptResultResult of the operation described above.
def resource_result(primitive: CompiledPrimitive, request: McpRequest, responses: tuple[McpResponse, ...], cache: CacheOptions) -> ReadResourceResult: (source)

Use only text/blob contents permitted by resources/read.

Parameters
primitive:orionis.mcp.server.compiler.CompiledPrimitiveCompiled tool, resource or prompt declaration.
request:orionis.mcp.McpRequestCurrent request and its trusted execution context.
responses:tuple[orionis.mcp.McpResponse, ...]Value supplied for responses.
cache:orionis.mcp.normalization.CacheOptionsValue supplied for cache.
Returns
orionis.mcp.protocol.results.ReadResourceResultResult of the operation described above.
def response_items(result: object) -> tuple[McpResponse, ...]: (source)

Accept explicit content responses and reject accidental arbitrary objects.

Parameters
result:objectValue supplied for result.
Returns
tuple[orionis.mcp.McpResponse, ...]Result of the operation described above.
async def tool_result(primitive: CompiledPrimitive, responses: tuple[McpResponse, ...]) -> CallToolResult: (source)

Validate structured output before publishing a successful result.

Parameters
primitive:orionis.mcp.server.compiler.CompiledPrimitiveCompiled tool, resource or prompt declaration.
responses:tuple[orionis.mcp.McpResponse, ...]Value supplied for responses.
Returns
orionis.mcp.protocol.results.CallToolResultResult of the operation described above.
async def validated_output(primitive: CompiledPrimitive, value: object) -> tuple[object, str | None]: (source)

Normalize declared structured output before publishing its wire value.

Parameters
primitive:orionis.mcp.server.compiler.CompiledPrimitiveTool declaration supplying its output schema.
value:objectHandler-provided structured content.
Returns
tuple[object, str | None]Validated JSON value and its generated text, or unchanged undeclared output.