API reference
The reference is organized by implementation because naming conventions, ownership, and asynchronous behavior follow each language. Conceptual roles remain aligned.
luxai-magpiePython API
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.
Shared conceptual surface
| Concept | Python | C++ | TypeScript |
|---|---|---|---|
| Streaming base | StreamWriter, StreamReader | StreamWriter, StreamReader | StreamWriter, StreamReader |
| RPC base | RpcRequester, RpcResponder | RpcRequester, RpcResponder | RpcRequester, RpcResponder |
| MQTT connection | MqttConnection | MqttConnection | MqttConnection |
| WebRTC connection | WebRTCConnection | WebRtcConnection | WebRtcConnection |
| Method schema | JsonRpcSchema | JsonRpcSchema | JsonRpcSchema |
| MCP tools | McpSchema, McpTransport | McpSchema server | McpSchema, McpTransport |
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 three packages release independently. Pin versions in production, read repository release notes, and test cross-language contracts before rolling out a new combination.