Resonite MCP

List all available and loaded plugins. Returns: Dictionary with plugin information Examples: List all plugins: plugin_list()

Load a plugin into the running server. Args: plugin_name: Name of the plugin to load Returns: Dictionary with plugin loading status Examples: Load OSC extensions: plugin_load("osc_extensions")

Reload a plugin in the running server. This unloads and then reloads the plugin, useful for applying configuration changes. Args: plugin_name: Name of the plugin to reload Returns: Dictionary with plugin reload status Examples: Reload ProtoFlux helpers: plugin_reload("protoflux_helpers")

Unload a plugin from the running server. Args: plugin_name: Name of the plugin to unload Returns: Dictionary with plugin unloading status Examples: Unload OSC extensions: plugin_unload("osc_extensions")

Analyze a ProtoFlux script structure via OSC introspection. Sends an OSC introspection request to Resonite and reports available ProtoFlux nodes, variables, and connections. ## Return Format {"success": bool, "message": str, "data": {"script_name": str, "status": str}} ## Examples protoflux_analyze_script("MyAnimation")

Start a ProtoFlux debugging session via OSC. Sends debug commands to Resonite via OSC to set breakpoints and trace execution for a named ProtoFlux script. ## Return Format {"success": bool, "message": str, "data": {"script_name": str, "debug_mode": str}} ## Examples protoflux_debug_session("MyAnimation", debug_mode="trace")

Generate documentation for a ProtoFlux script. Queries ResoniteLink (if connected) or OSC for script metadata and returns structured documentation. ## Return Format {"success": bool, "message": str, "data": {"script_name": str, "sections": list}} ## Examples protoflux_document_script("MyAnimation")

Generate a ProtoFlux script template description. Returns a documented template for common ProtoFlux patterns. The template can be used as a recipe to build the script in Resonite. ## Return Format {"success": bool, "message": str, "data": {"template_type": str, "nodes": list, "description": str}} ## Examples protoflux_generate_template("avatar_animation") protoflux_generate_template("world_interaction", {"sound": "click.wav"})

Send optimization hints for a ProtoFlux script. Accepts optimization settings and returns a recipe of changes the user can apply in Resonite's ProtoFlux editor. ## Return Format {"success": bool, "message": str, "data": {"script_name": str, "suggestions": list}} ## Examples protoflux_optimize_script("MyAnimation", optimization_level="aggressive")

Load an avatar into the current Resonite session. Args: input_data: Avatar loading configuration (avatar_id, slot, parameters) Returns: Dictionary with avatar loading status

Delete a cloud variable. Args: path: Cloud variable path to delete user_id: User ID (U-...). Defaults to authenticated user. ## Return Format {"status": "ok", "path": str}

Get a cloud variable value by its path. Args: path: Full cloud variable path (e.g. "Cloud/MyVar") user_id: User ID (U-...). Defaults to authenticated user. ## Return Format {"status": "ok", "path": str, "value": any}

List cloud variable definitions for a user. Cloud variables are key-value pairs stored in Resonite's cloud. Requires authentication. Args: user_id: User ID (U-...). Defaults to authenticated user. path: Cloud variable path prefix to filter by. ## Return Format {"status": "ok", "variables": [...], "count": int}

Set a cloud variable value. Creates the variable if it does not exist. Args: path: Cloud variable path (e.g. "Cloud/MyVar") value: The value to store (string, number, bool, or JSON-serializable) user_id: User ID (U-...). Defaults to authenticated user. ## Return Format {"status": "ok", "path": str, "value": any}

Show Resonite MCP fleet status as a rich Prefab card. Displays server health, Resonite process status, OSC connectivity, ResoniteLink status, and tool counts in a scannable card.

Cross-fleet asset pipeline into Resonite (inkscape UI, blender GLB, gimp textures).

Get a friend's presence and current session info. Args: user_id: The friend's user ID (U-...) ## Return Format {"status": "ok", "user_id": str, "presence": {...}}

List pending friend requests (incoming). Requires authentication. ## Return Format {"status": "ok", "requests": [...], "count": int}

List your Resonite friends. Requires authentication. ## Return Format {"status": "ok", "friends": [...], "count": int}

Show a browsable inventory preview as a rich Prefab card. Displays recent inventory items with names, types, and availability status in a scannable card format. Args: limit: Max items to display (default 10)

Delete an item from the user's Resonite inventory.

Get detailed information about an inventory item.

List items in the user's Resonite inventory. Args: input_data: Inventory list configuration (item_type, search_query, limit, offset) Returns: Dictionary with inventory items and pagination info

Search for items in the user's Resonite inventory.

Share an inventory item with another user.

Spawn an item from inventory into the current world.

Upload a local file to Resonite inventory.

Attach a component to a slot, optionally initializing members. component_type uses Resonite syntax, e.g. "[FrooxEngine]FrooxEngine.Grabbable". members example: {"Scalable": true}. Use resonite_link_reflect to discover types. ## Return Format {"status": str, "slot_id": str, "component_id": str, "component_type": str}

Create a new slot in the connected world. Args: name: Name for the new slot parent_id: Parent slot ID (default "Root") pos_x/pos_y/pos_z: Local position slot_id: Optional client-chosen ID (avoid the "Reso_" prefix) ## Return Format {"status": str, "parent_id": str, "slot_id": str, "name": str}

Loop-animate a slot in place: 'spin' (continuous rotation), 'bob' (smooth sinusoidal vertical oscillation), or 'bounce' (real drop-and-rebound physics with energy loss per landing, not a sine wave). Server-driven - repeated updateSlot calls over the ResoniteLink WebSocket, not a baked animation clip. Blocks for duration_s while it runs. speed: 'spin' radians/second, 'bob' oscillations/second, 'bounce' overall pace (scales effective gravity). amplitude: 'bob'/'bounce' peak height above rest, in meters. damping: 'bounce' only, energy retained per bounce (0-1). ## Return Format {"status…

Execute multiple data-model operations atomically (dataModelOperationBatch). Each operation is a real protocol message with "$type", e.g.: - {"$type": "addSlot", "data": {"name": {"$type": "string", "value": "X"}}} - {"$type": "updateComponent", "data": {"id": "...", "members": {...}}} - {"$type": "removeSlot", "slotId": "..."} - {"$type": "callSyncMethod", "targetID": "...", "methodName": "...", "arguments": {}} ## Return Format {"status": str, "response": {...}}

Call a sync method on a component/object (callSyncMethod, protocol 0.11.0+). Args: target_id: ID of the object to call the method on method_name: Method name arguments: {argName: value} - primitives auto-encoded ## Return Format {"status": str, "target_id": str, "method": str, "result": {...}}

Connect to the ResoniteLink WebSocket server. ResoniteLink is built into Resonite (no mod needed); the session HOST must enable it: Dashboard -> Session -> Settings -> Enable ResoniteLink. Default port 4242, but prefer resonite_link_discover to find the real port. ## Return Format {"status": str, "message": str, "session_info": {resoniteVersion, resoniteLinkVersion, uniqueSessionId}}

Copy a local file into the model or texture depot and register it in the manifest. file_path must already exist on disk (this copies it in, it does not fetch URLs). Fails if a depot entry with the same filename already exists - use resonite_link_depot_update_metadata to change description/category, or resonite_link_depot_remove first to replace it. ## Return Format {"status": str, "kind": str, "name": str, "size": int}

Zip-snapshot the model and texture depots into data/backups/<timestamp>.zip. Does not touch the live Resonite world - this backs up depot files this server manages locally, not anything inside a running session. ## Return Format {"status": str, "name": str, "size": int}

List entries in the model or texture depot. kind: "model" or "texture". ## Return Format {"status": str, "kind": str, "items": [{"name","description","category","exists","size"}], "count": int}

List available depot backup archives, newest first. ## Return Format {"status": str, "backups": [{"name","size","created_at"}], "count": int}

Delete a depot entry: removes the file on disk and its manifest entry. ## Return Format {"status": str, "kind": str, "name": str}

Restore a depot backup archive, OVERWRITING current files in the model/texture depots (matching names only - does not delete files the backup doesn't mention). Does not touch the live Resonite world. ## Return Format {"status": str, "name": str, "restored": int}

Spawn a depot model into the world, or import a depot texture and hand back its asset URL. kind="model": converts the .glb/.vrm/.gltf via gltf_to_mesh_json() (the same live-verified path used for Nekomimi-chan) and spawns it with client.spawn_mesh() at (pos_x,pos_y,pos_z). kind="texture": imports via client.import_texture_file() and returns the asset_url only - there is no mesh to attach it to here. Wire it into a material yourself, e.g.: resonite_link_add_component(slot_id, "[FrooxEngine]FrooxEngine.PBS_Metallic", {"AlbedoTexture": {"$type": "reference", "targetId": ...}}) # se…

Update description/category for an existing depot entry (file itself untouched). ## Return Format {"status": str, "kind": str, "name": str}

Remove a slot and its children (removeSlot). Note: preserve_assets is accepted for compatibility but the protocol has no such option; it is ignored with a warning. ## Return Format {"status": str, "slot_id": str}

Discover ResoniteLink sessions announced on the local network (UDP 12512). Resonite (0.12.0+ protocol) broadcasts active ResoniteLink sessions every ~10 seconds. Use this instead of guessing the port; then connect with resonite_link_connect using the discovered linkPort. Args: timeout_seconds: How long to listen (default 12s catches one announce cycle) ## Return Format {"status": str, "sessions": [{"sessionName", "sessionID", "linkPort", "host"}], "count": int}

Read a member value from a Resonite component (component_id + member name).

List direct children of a slot ("Root" for top level). ## Return Format {"status": str, "slot_id": str, "children": [...], "count": int}

Get slot or component information by ID (tries slot first, then component). ## Return Format {"status": str, "ref_id": str, "node": {...}}

Fetch slot data from the connected world's scene hierarchy. Args: slot_id: Slot ID ("Root" for the world root) include_component_data: Include full component members (bulkier) depth: 0 = only this slot, 1 = with children, -1 = entire subtree ## Return Format {"status": str, "slot_id": str, "data": {...}}

Import a mesh asset from JSON vertex/submesh data (importMeshJSON). Live-verified 2026-07-18. Returns an asset URL, not an entity ID - wire it into a StaticMesh component's URL member (type "Uri") to render it, or use resonite_link_spawn_mesh to do the whole chain in one call. vertices: [{"position": {"x","y","z"}}, ...] (each may also carry "normal"/"tangent"/"color"/"boneWeights", plus UVs as "uv0" = {"$type": "2D", "uv": {"x","y"}} -- live-verified 2026-09-18; the old "uvs" list shape is rejected). submeshes: [{"$type": "triangles", "triangles": [{"vertex0Index", "vertex1I…

Import a texture from a file path on the RESONITE HOST machine (importTexture2DFile). NOTE: file_path is resolved on the machine running Resonite, not the machine running this MCP server - matters if they differ. Wire shape is confirmed against the upstream C# source but has NOT been live-tested against a running session yet; treat results with appropriate caution until it has been run once for real. ## Return Format {"status": str, "asset_url": str} or {"status": "error", "message": str}

Read a component's data (type + all members) by component ID. Note: ResoniteLink reads whole components, not individual field refs. Member values are in data.members, matching Resonite inspector names. ## Return Format {"status": str, "ref_id": str, "value": {...}}

Discover component types or member definitions. Without component_type: getComponentTypeList (all available types). With component_type: getComponentDefinition (member definitions; note that member types are type REFERENCES since protocol 0.9.0 - resolve them via the typeDefinition messages if needed). ## Return Format {"status": str, "types": {...}} or {"status": str, "component_type": str, "data": {...}}

Set a member value on a Resonite component (component_id + member name).

Create a named, positioned slot in the world. NOTE: ResoniteLink has no template-URL spawning. If template_url is a resonite:// or file path, this returns not_implemented with guidance; otherwise it is used as the slot name.

Spawn a preset test fixture (box/cup/ball/table/chair) for gripper/manipulation testing. Multi-part fixtures (table, chair) spawn as several independent slots near each other, not parented - static set-dressing that never needs to move as a unit. Unlike overte-mcp's equivalent, there is no "in front of you" default placement - ResoniteLink cannot read the local user's position (no such message exists in the protocol), so pos_x/y/z must be given explicitly; they default to the world origin. color_r/g/b/a: 0-1 floats, applied uniformly to every part. Default white. ## Return Format {"status":…

Import a JSON mesh and wire the full render chain in one call. Convenience wrapper live-verified 2026-07-18 (as three separate manual steps that night; now one call): importMeshJSON -> addSlot -> StaticMesh -> MeshRenderer -> (if color given) PBS_Metallic wired into Materials. color_r/g/b: pass all three (0-1 floats) to also paint the mesh, e.g. orange = (1.0, 0.45, 0.05). Omit any one to skip material creation. ## Return Format {"status": str, "slot_id": str, "asset_url": str, "static_mesh_id": str, "renderer_id": str, "material_id": str (only if color given)}

Write one member on a component (updateComponent). Args: component_id: The component's ID member: Member name exactly as shown in the Resonite inspector value: The value (bool/int/float/string auto-encoded; dicts with x/y/z -> float3) value_type: Optional explicit protocol type ("float3", "colorX", "reference", ...) ## Return Format {"status": str, "component_id": str, "member": str}

Set an avatar parameter value in Resonite. Args: parameter_name: Name of the parameter to set value: Parameter value (typically 0.0 to 1.0) avatar_slot: Specific avatar slot (0-7), affects all if not specified

Execute a ProtoFlux script in Resonite. Args: input_data: Script configuration (script_name, script_data, execute)

Get Resonite platform/server information. Does not require authentication. Returns: Platform info including build version and status. Examples: >>> await resonite_rest_get_platform() {"status": "ok", "platform": {"version": "...", ...}}

Browse a user's Resonite inventory records. Requires authentication (resonite_rest_login first, or RESONITE_USER_ID + RESONITE_TOKEN env vars). Args: user_id: User ID (U-...). Defaults to authenticated user. path: Inventory path to list (e.g. 'Inventory/WorldLabs'). Omit to list root. record_id: If provided, fetch a single record (R-...). Returns: Records at the specified path. Examples: >>> await resonite_rest_get_records(path="Inventory") {"status": "ok", "records": [...], "count": 12}

List public Resonite world sessions. Does not require authentication. Args: name: Filter by session name (partial match). host_name: Filter by host's username. host_id: Filter by host's user ID (starts with U-). min_active_users: Minimum number of active users. include_empty_headless: Include empty headless servers. Returns: List of public sessions. Examples: >>> await resonite_rest_get_sessions(name="WorldLabs") {"status": "ok", "sessions": [...], "count": 3}

Look up a Resonite user by username or user ID. Args: username_or_id: Username or user ID (U-...). Automatically detects format. Returns: User profile object. Examples: >>> await resonite_rest_get_user("Frooxius") {"status": "ok", "user": {"id": "U-...", "username": "Frooxius", ...}}

Log in to the Resonite API and store the session token. Args: username: Your Resonite username or email. password: Your Resonite password. remember_me: If True, token valid 30 days; otherwise 24 hours. Returns: Session details including user_id and token (stored for subsequent calls). Examples: >>> await resonite_rest_login("MyUser", "hunter2") {"status": "ok", "user_id": "U-...", "token": "...", "expires": "..."}

Send a chat message to a Resonite user via the REST API. Useful for sending a World Labs GLB/SPZ URL to yourself or a collaborator so it can be imported inside Resonite by dragging the link. Requires authentication. Args: target_user_id: The recipient's user ID (U-...). message: The message text. For asset import, use the signed asset URL. Returns: Confirmation of the sent message. Examples: >>> await resonite_rest_send_message("U-Frooxius", "https://cdn.worldlabs.ai/.../world.glb") {"status": "ok", "message_id": "M-..."}

End the current Resonite session and clean up resources. Returns: Dictionary with session cleanup status Examples: End session: resonite_session_end()

Start a new Resonite session with optional world and avatar setup. This initializes OSC communication with Resonite and sets up a session for avatar control, world management, and social interactions. Args: input_data: Session configuration (session_name, world_path, avatar_slot) Returns: Dictionary with session information and status Examples: Start basic session: resonite_session_start({}) Start with world: resonite_session_start({"world_path": "resonite://TutorialWorld"})

Get the current status of the active Resonite session. Returns: Dictionary with session status and active components Examples: Check session status: resonite_session_status()

Move the vBot head to the given yaw/pitch angles. Args: robot_id: The robot ID yaw_deg: Yaw angle in degrees pitch_deg: Pitch angle in degrees ## Return Format {"success": bool, "robot_id": str, "yaw_deg": float, "pitch_deg": float}

List available vBot robot types and their OSC contracts. Returns types: yahboom (vBoomy), mechazilla (vMechazilla), bumi (vBumi), godzilla (kaiju scale), custom. Each type has default scale and drive mode. ## Return Format {"status": "success", "types": [...], "count": int}

Send move command to a vBot in Resonite. Holonomic drive: linear = forward/backward speed (m/s), angular = yaw rotation (rad/s). Args: robot_id: The robot ID (e.g. "vbot_yahboom_01") linear: Forward velocity in m/s (positive = forward) angular: Yaw angular velocity in rad/s (positive = clockwise) ## Return Format {"success": bool, "robot_id": str, "linear": float, "angular": float}

Spawn a vBot in Resonite at the given position and scale. The Resonite world must have the vBot OSC receiver ProtoFlux graph listening on port 9000 (see docs/VBOT_OSC_RECEIVER.md). Args: robot_type: yahboom, mechazilla, bumi, godzilla, or custom robot_id: Unique robot ID (auto-generated if empty) position_x/y/z: Spawn position in 3D world coordinates scale: Spawn scale. Use 0 for type default. ## Return Format {"success": bool, "robot_id": str, "robot_type": str, "position": {...}}

Stop a vBot - zero all locomotion commands. Args: robot_id: The robot ID to stop ## Return Format {"success": bool, "robot_id": str}

Local LLM-assisted voice macros over OSC.

Load a world in the current Resonite session. Args: world_path: Path to the world (resonite:// format for built-in worlds, file:// for local files, inventory:// for user inventory) Returns: Dictionary with world loading status Examples: Load built-in world: resonite_world_load("resonite://TutorialWorld") Load from inventory: resonite_world_load("inventory://MyCustomWorld") Load local file: resonite_world_load("file:///path/to/world.resonite")

Semantic vector search over the bundled Resonite technical guides (repo *.md + docs/**/*.md, embedded with sentence-transformers all-MiniLM-L6-v2 in LanceDB). Use this when you need raw source passages to quote or to ground a follow-up call. Use ask_resonite instead when you want one synthesized natural-language answer rather than passages. Args: query: Natural-language search query (e.g. "how do avatar parameters work via OSC"). limit: Max passages to return (1-20). Defaults to 5. Returns: {"status": "success"|"error", "results": [{"title": str, "filename": str, "text": str}], …

Send an OSC message to the specified address. This is a low-level OSC function for direct protocol control. Most users should use the higher-level Resonite-specific tools instead. Args: input_data: OSC message details (host, port, address, values) Returns: Dictionary with operation status and details Examples: Send a parameter value: send_osc({"host": "127.0.0.1", "port": 9000, "address": "/avatar/happy", "values": [0.8]})

Start an OSC server to receive incoming messages from Resonite. This creates a UDP server that can receive OSC messages from Resonite for bidirectional communication and real-time feedback. Args: input_data: Server configuration (port, address) Returns: Dictionary with server status and connection details Examples: Start server for Resonite feedback: start_osc_server({"port": 9001})

Get comprehensive server status and diagnostic information. Provides detailed information about server health, plugin status, system resources, and operational metrics at different detail levels. Args: level: Status detail level (basic, intermediate, advanced) focus: Optional focus area (plugins, osc, system, session) Returns: Formatted status report with diagnostics and metrics Examples: status() # Basic server overview status("intermediate") # Detailed operational status status("advanced") # Full diagnostic information status("…

Stop a running OSC server. Args: input_data: Port of the server to stop Returns: Dictionary with operation status Examples: Stop OSC server: stop_osc_server({"port": 9001})

Test OSC functionality by sending and receiving a message.