Skip to main content

Windows-first Webots developer toolkit with CLI, MCP server, controller SDK, and bundled benchmarks.

Project description

webots-mcp-kit

webots-mcp-kit is a Windows-first toolkit for running Webots with a stable CLI, MCP server, controller SDK, bundled benchmarks, and structured world/controller authoring workflows for e-puck task worlds. v2.2.0 focuses on team adoption: starter workspaces, repeatable upgrade checks, and clearer team-facing docs on top of the existing runtime and authoring surface.

Support Matrix

Area Supported
OS Windows
Webots R2025a
Python 3.11+
Runtime model interactive-webots
Robot family e-puck
Package distribution PyPI + GitHub
Runtime workflows doctor, session, benchmark, import/export/replay
Authoring workflows controller scaffold/inspect/edit/validate, world inspect/validate/edit, scenario init/validate/build/doctor

Supported baseline: Windows, Webots R2025a, Python 3.11+, interactive-webots, e-puck.

Unsupported Matrix

Area Not supported in v2.2.0
Runtime Windows service runner, Linux, macOS
Robotics stack ROS2, multi-robot orchestration
World generation free-form natural-language-to-world generation
Distribution .exe, winget, standalone website, marketplace/app-directory packaging

5-Minute Quickstart

From a repo checkout on a Windows machine with Webots R2025a installed:

pipx install webots-mcp-kit
powershell -ExecutionPolicy Bypass -File .\scripts\verify_install.ps1 -Runtime

That path verifies:

  • doctor
  • bundled benchmark discovery
  • temporary controller scaffold + validate
  • bundled world inspect
  • a short real line-follower benchmark

If pipx is not installed yet, use the helper:

powershell -ExecutionPolicy Bypass -File .\scripts\install.ps1
powershell -ExecutionPolicy Bypass -File .\scripts\verify_install.ps1 -Runtime

Choose Your Path

For Teams

Use the team starter workspaces when you want a repeatable path that can be handed to another developer without extra setup decisions:

powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap_workspace.ps1 -Starter line-follower -Destination .\workspaces\line-follower-demo
powershell -ExecutionPolicy Bypass -File .\scripts\upgrade_check.ps1 -Workspace .\artifacts\upgrade-check -Runtime

Use Team flows when you want the exact command sequence for:

  • evaluator flow
  • controller author flow
  • world author flow
  • importer and triage flow

Install And Upgrade

Primary install path:

pipx install webots-mcp-kit

Upgrade with the same tool:

pipx upgrade webots-mcp-kit

Repo-assisted install from a checkout:

powershell -ExecutionPolicy Bypass -File .\scripts\install.ps1

Fallback path when you do not want pipx:

python -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install webots-mcp-kit

Packaging, pinned-version, and wheel-install details live in PyPI install and upgrade. Upgrade and post-release verification live in Upgrade guide.

Troubleshooting

If install or runtime verification fails, start with Troubleshooting.

Bundled Scenarios

  • line-follower: camera-based line tracking and the canonical first-success benchmark
  • obstacle-avoidance: proximity-sensor obstacle avoidance
  • waypoint-nav: waypoint navigation with benchmarked goal progress

CLI And MCP Overview

Core CLI areas:

  • runtime: doctor, session start/inspect/logs/export/replay/stop, benchmark list/run/report
  • controller authoring: controller scaffold, controller inspect, controller edit, controller validate
  • world authoring: world inspect, world validate, world edit
  • zero-to-sim: project init, scenario init, scenario validate, scenario build, scenario describe, scenario doctor
  • import/replay: project import, session export, session replay
  • MCP bridge: mcp serve

Core MCP tools:

  • runtime: webots_session_start, webots_get_state, webots_get_sensors, webots_capture_camera, webots_run_benchmark
  • world authoring: webots_world_inspect, webots_world_validate, webots_world_edit
  • controller authoring: webots_controller_scaffold, webots_controller_inspect, webots_controller_validate, webots_controller_edit

Authoring workflows are supported on the stable release line, but the deeper schema surfaces remain experimental-foundation and additive.

Docs Map

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webots_mcp_kit-2.2.0.tar.gz (120.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

webots_mcp_kit-2.2.0-py3-none-any.whl (118.2 kB view details)

Uploaded Python 3

File details

Details for the file webots_mcp_kit-2.2.0.tar.gz.

File metadata

  • Download URL: webots_mcp_kit-2.2.0.tar.gz
  • Upload date:
  • Size: 120.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for webots_mcp_kit-2.2.0.tar.gz
Algorithm Hash digest
SHA256 928c75dc3d9012a5870b1fea904aa5a7b86c6fb3c07461870d11af40c44b996a
MD5 391e898c4bf370cf77f7d821823c35c8
BLAKE2b-256 696fa2c08b7ee25ad98b70c688f295f32a8026f0527ac33a96ce2023ad4b0341

See more details on using hashes here.

Provenance

The following attestation bundles were made for webots_mcp_kit-2.2.0.tar.gz:

Publisher: release.yml on RdaKA12/webots-mcp-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file webots_mcp_kit-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: webots_mcp_kit-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 118.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for webots_mcp_kit-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77e28377ba71ed8707562f623e217a4a76823e8668a8d2676f0cbba98879eb86
MD5 e8101de8a3ff5599bdea3a5f47f6775c
BLAKE2b-256 783951147757da60de9f7d3f44bdbe0226002a73e63fbd06a295991b584a983a

See more details on using hashes here.

Provenance

The following attestation bundles were made for webots_mcp_kit-2.2.0-py3-none-any.whl:

Publisher: release.yml on RdaKA12/webots-mcp-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page