API reference
The reference is organized by implementation because naming conventions, ownership, and asynchronous behavior follow each language. Conceptual roles remain aligned.
Transports, frames, nodes, schemas, discovery, adapters, and CLI tools.
libmagpieC++ APIHeaders, link targets, optional libraries, ownership, and native types.
@luxai-qtrobot/magpieTypeScript APIBrowser and Node.js exports, async methods, frames, schema, and MCP.
magpie-upyMicroPython APIAsync ZMQ and optional MQTT, streams, RPC, primitive and image frames, schemas, and on-device MCP tools.
Shared conceptual surface
| Concept | Python | C++ | TypeScript | MicroPython |
|---|---|---|---|---|
| Streaming base | StreamWriter, StreamReader | StreamWriter, StreamReader | StreamWriter, StreamReader | Async StreamWriter, StreamReader |
| RPC base | RpcRequester, RpcResponder | RpcRequester, RpcResponder | RpcRequester, RpcResponder | Async RpcRequester, RpcResponder |
| Direct ZMQ | Zmq* / ZMQ* classes | Zmq* classes | — | Async Zmq* classes |
| MQTT connection | MqttConnection | MqttConnection | MqttConnection | Async MqttConnection |
| WebRTC connection | WebRTCConnection | WebRtcConnection | WebRtcConnection | — |
| Method schema | JsonRpcSchema | JsonRpcSchema | JsonRpcSchema | JsonRpcSchema |
| MCP tools | McpSchema, McpTransport | McpSchema server | McpSchema, McpTransport | McpSchema 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.