Skip to documentation
Developer docsPython SDK v1.3.0·stdio MCP
Browse documentation

Reference

MCP tool reference

A practical guide to discovery, projects, route editing, styling, rendering, and account sync.

Package v1.3.0·Reviewed September 29, 2026
On this pageStart with discoveryProjectsRoute editingMaps, models, and animationRenderingAccount syncTypical call sequence

Start with discovery

get_capabilities checks the rendering environment; auth_status checks the local login. Use the tool schemas exposed by your installed server for exact required fields, types, and version-specific additions. The groups below summarize the published reference.

Projects

Project tools use explicit project_id values. Keep the returned ID from creation; there is no implicit current project.

  • create_project — create a named local project.
  • list_projects / get_project — find and inspect existing work.
  • import_project / export_project — move an ExportConfig into or out of a project.
  • delete_project — permanently remove a local project and its rendered videos.

Route editing

Waypoint indexes are zero-based. Read get_route before editing an index. create_route expects an empty route; replacing existing work requires an explicit clear.

  • create_route / get_route — create or inspect the waypoint list.
  • add_point / update_point / remove_point — edit individual stops.
  • clear_route — remove all waypoints.
  • set_real_route — enable or disable road geometry for the segment starting at an index. The last waypoint has no outgoing segment.

Maps, models, and animation

Fetch catalogue IDs rather than guessing them. Inspect get_animation_state before sending partial updates with update_animation_state.

  • list_maps — available maps and subscription requirements.
  • list_models — vehicles and other models; request detail when texture IDs are needed.
  • list_line_styles — valid route-line styles.
  • get_animation_state / update_animation_state — inspect and change duration, projection, output framing, map, line, and label settings.

Rendering

estimate_render gives an estimate without starting a render. render_video validates and starts a background job, returning a session ID.

  • await_render — wait for completion; relay progress and wait again if timed_out is true.
  • get_render_progress — make a single progress check.
  • get_render_result — retrieve a completed session’s output.
  • cancel_render — stop a running job.

Account sync

Account routes preserve waypoints, not every local project setting. Report the dropped list returned by a save.

  • list_account_routes — browse saved routes.
  • save_project_to_account — send a local route to the account.
  • load_account_route — create a new local project from a saved route.
  • delete_account_route — delete the saved route from the account and mobile app.

Typical call sequence

Workflow
get_capabilities → auth_status
create_project → create_route
list_maps / list_models → update_animation_state
estimate_render → render_video → await_render
get_render_result