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. v2.9.0 extends the MonsterBorg hardening line from line-follow into obstacle avoidance, waypoint navigation, tuning analytics, and an optional Raspberry Pi physical parity gate on top of the existing e-puck and MonsterBorg runtime surfaces.

Support Matrix

Area Supported
OS Windows
Webots R2025a
Python 3.11+
Runtime model interactive-webots
Robot family e-puck, MonsterBorg 4WD
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, plus MonsterBorg 4WD Webots support and the Raspberry Pi physical-adapter lane on the current release line.

Unsupported Matrix

Area Not supported on v2.9.0
Runtime Windows service runner, Linux, macOS, live MCP control of physical robots
Robotics stack ROS2, multi-robot orchestration
World generation free-form natural-language-to-world generation
Distribution .exe, winget, standalone website, marketplace/app-directory packaging
Physical robot lane general Linux runtime, non-MonsterBorg hardware adapters

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

MonsterBorg verification uses the same public script:

powershell -ExecutionPolicy Bypass -File .\scripts\verify_install.ps1 -RobotProfile monsterborg-4wd -Runtime

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

MonsterBorg starter workspaces:

powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap_workspace.ps1 -Starter monsterborg-line-follower -Destination .\workspaces\monsterborg-line-follower
powershell -ExecutionPolicy Bypass -File .\scripts\upgrade_check.ps1 -Workspace .\artifacts\monsterborg-upgrade-check -RobotProfile monsterborg-4wd -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 or front-range obstacle avoidance
  • waypoint-nav: waypoint navigation with benchmarked goal progress

Robot profiles:

  • e-puck: stable bundled task-world baseline
  • monsterborg-4wd: bundled support with generated templates, bundled Webots examples, and robot-aware controller/world/import flows

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

Additive robot-aware flags:

  • --robot-profile e-puck
  • --robot-profile monsterborg-4wd

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. In v2.9.0, the MonsterBorg task-hardening line adds obstacle and waypoint variants, task-aware replay summaries, a benchmark matrix helper, and the optional Raspberry Pi physical parity gate.

MonsterBorg task-hardening extras:

  • bundled variant specs under examples/monsterborg/line-follower/variants
  • bundled variant specs under examples/monsterborg/obstacle-avoidance/variants
  • bundled variant specs under examples/monsterborg/waypoint-nav/variants
  • richer benchmark report and session replay task metrics for line-follow, obstacle, and waypoint
  • python scripts/monsterborg_benchmark_matrix.py <report-or-export>... --output <json>
  • python scripts/monsterborg_calibration_report.py --sim-export <dir> --physical-export <dir> --output <json>

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.10.4.tar.gz (189.1 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.10.4-py3-none-any.whl (200.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for webots_mcp_kit-2.10.4.tar.gz
Algorithm Hash digest
SHA256 ff6f661aef300710c2590c50dd14b772b5a2e49d6231432e8e3937ecd0b182dd
MD5 23d5cb9e8cb40c0a964f593b1b8cd18e
BLAKE2b-256 98d866ea7098122dac9861eb69752a3607fd1c8428fc70f9207b2e626d9b45f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for webots_mcp_kit-2.10.4.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.10.4-py3-none-any.whl.

File metadata

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

File hashes

Hashes for webots_mcp_kit-2.10.4-py3-none-any.whl
Algorithm Hash digest
SHA256 980c1745a59d73dbc3ea4475d8130d3a1211641accbd4b36d93086fbd253ec63
MD5 aa3d610fdcf0537313fe5e29d33c1c27
BLAKE2b-256 098ad487d5189f140c87126c5a1e42c3e6b2910988212b52ddc0f4e5cc2af7fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for webots_mcp_kit-2.10.4-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