Skip to main content

API reference

The reference is organized by implementation because naming conventions, ownership, and asynchronous behavior follow each language. Conceptual roles remain aligned.

Shared conceptual surface​

ConceptPythonC++TypeScriptMicroPython
Streaming baseStreamWriter, StreamReaderStreamWriter, StreamReaderStreamWriter, StreamReaderAsync StreamWriter, StreamReader
RPC baseRpcRequester, RpcResponderRpcRequester, RpcResponderRpcRequester, RpcResponderAsync RpcRequester, RpcResponder
Direct ZMQZmq* / ZMQ* classesZmq* classes—Async Zmq* classes
MQTT connectionMqttConnectionMqttConnectionMqttConnectionAsync MqttConnection
WebRTC connectionWebRTCConnectionWebRtcConnectionWebRtcConnection—
Method schemaJsonRpcSchemaJsonRpcSchemaJsonRpcSchemaJsonRpcSchema
MCP toolsMcpSchema, McpTransportMcpSchema serverMcpSchema, McpTransportMcpSchema server

Use the language pages for exact spelling and lifecycle behavior. Use Compatibility before planning a mixed-language deployment.

Stability guidance​

MAGPIE is under active development and the four implementations release independently. Pin versions in production, read repository release notes, and test cross-language contracts before rolling out a new combination.