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.
Undocumented
| Class | _ |
An independent catalog invocation, with no Python call kwargs. |
| Class | _ |
Own only boot-time schema caches; discard them after the registry is built. |
| Class | _ |
Request limits are additionally enforced by the dispatcher configuration. |
| Class | _ |
Bounded searchable catalog arguments. |
| Class | |
One hidden catalog and its deterministic boot-time lexical index. |
| Class | |
A definition reusable by every request, worker and supported transport. |
| Class | |
Unbound declaration metadata, with no identity or per-call service instance. |
| Function | _capabilities |
Advertise only the methods and notifications backed by this registry. |
| Function | _extend |
Let extensions attach data without changing compiled native contracts. |
| Function | _extensions |
Reject extension collisions with built-in methods and other extensions. |
| Function | _hook |
Compile optional per-request checks without resolving a handler instance. |
| Function | _insert |
Reject collisions at boot instead of changing lookup semantics silently. |
| Function | _metadata |
Snapshot common metadata before adding primitive-specific wire fields. |
| Function | _name |
Derive readable kebab names while honoring explicit protocol identifiers. |
| Function | _ordered |
Keep deterministic name order in the compiled mapping, including URI keys. |
| Function | _resource |
Reject identical URI/template names and automatically detectable ambiguity. |
| Function | _tool |
Enumerate generic Tool arguments in method resolution order. |
| Function | _tool |
Compile visible and hidden tool namespaces with collision checks. |
| Function | _tool |
Resolve explicit or generic input and output declarations. |
| Function | _validate |
Check declaration constructors once, keeping validation off list hot paths. |
| Function | _wire |
Freeze wire metadata into immutable JSON without retaining mutable maps. |
| Function | compile |
Compile one definition without resolving services or retaining runtime state. |
| Function | validate |
Enforce the advertised native output type before encoding structured data. |
| Function | validate |
Validate only the tool's argument object, never the HTTP JSON-RPC envelope. |
| Function | validate |
Check required/unknown argument names and the protocol's string values. |
| Constant | _CORE |
Undocumented |
| Constant | _NAME |
Undocumented |
type[ Server], tools: Mapping[ str, CompiledPrimitive], resources: Mapping[ str, CompiledPrimitive], prompts: Mapping[ str, CompiledPrimitive], templates: tuple[ CompiledPrimitive, ...]) -> dict[ str, object]:
(source)
¶
Advertise only the methods and notifications backed by this registry.
| Parameters | |
definition:type[Server] | Class declaration whose metadata is being inspected. |
tools:Mapping[str, CompiledPrimitive] | Value supplied for tools. |
resources:Mapping[str, CompiledPrimitive] | Value supplied for resources. |
prompts:Mapping[str, CompiledPrimitive] | Value supplied for prompts. |
templates:tuple[CompiledPrimitive, ...] | Value supplied for templates. |
| Returns | |
dict[str, object] | Result of the operation described above. |
Reject extension collisions with built-in methods and other extensions.
| Parameters | |
definition:type[Server] | Class declaration whose metadata is being inspected. |
| Returns | |
tuple[McpExtension, ...] | Result of the operation described above. |
dict[ str, CompiledPrimitive], key: str, primitive: CompiledPrimitive):
(source)
¶
Reject collisions at boot instead of changing lookup semantics silently.
| Parameters | |
registry:dict[str, CompiledPrimitive] | Value supplied for registry. |
key:str | Value supplied for key. |
primitive:CompiledPrimitive | Compiled tool, resource or prompt declaration. |
| Returns | |
None | Complete the documented operation without returning a value. |
Keep deterministic name order in the compiled mapping, including URI keys.
| Parameters | |
registry:dict[str, CompiledPrimitive] | Value supplied for registry. |
| Returns | |
dict[str, CompiledPrimitive] | Result of the operation described above. |
_Compiler, entries: tuple[ type[ Resource], ...]) -> tuple[ dict[ str, CompiledPrimitive], tuple[ CompiledPrimitive, ...]]:
(source)
¶
Reject identical URI/template names and automatically detectable ambiguity.
| Parameters | |
compiler:_Compiler | Value supplied for compiler. |
entries:tuple[type[Resource], ...] | Value supplied for entries. |
| Returns | |
tuple[dict[str, CompiledPrimitive], tuple[CompiledPrimitive, ...]] | Result of the operation described above. |
_Compiler, entries: tuple[ object, ...]) -> tuple[ dict[ str, CompiledPrimitive], dict[ str, CompiledPrimitive], tuple[ CompiledCatalog, ...]]:
(source)
¶
Freeze wire metadata into immutable JSON without retaining mutable maps.
| Parameters | |
value:object | Value to inspect, transform or validate. |
| Returns | |
msgspec.Raw | Result of the operation described above. |
Compile one definition without resolving services or retaining runtime state.
| Parameters | |
definition:type[Server] | Class declaration whose metadata is being inspected. |
| Returns | |
CompiledMcpServer | Result of the operation described above. |
Enforce the advertised native output type before encoding structured data.
| Parameters | |
primitive:CompiledPrimitive | Compiled tool, resource or prompt declaration. |
value:object | Value to inspect, transform or validate. |
| Returns | |
object | Result of the operation described above. |
Validate only the tool's argument object, never the HTTP JSON-RPC envelope.
| Parameters | |
primitive:CompiledPrimitive | Compiled tool, resource or prompt declaration. |
arguments:object | Arguments supplied for this operation. |
| Returns | |
object | Result of the operation described above. |
CompiledPrimitive, arguments: Mapping[ str, object]):
(source)
¶
Check required/unknown argument names and the protocol's string values.
| Parameters | |
primitive:CompiledPrimitive | Compiled tool, resource or prompt declaration. |
arguments:Mapping[str, object] | Arguments supplied for this operation. |
| Returns | |
None | Complete the documented operation without returning a value. |
Undocumented
| Value |
|