API Reference bb_mcp v#0.1.0

Copy Markdown View Source

Modules

Model Context Protocol server for Beam Bots robots.

Per-session ring buffer for BB pubsub events.

Convert BB.MCP.EventBuffer entries into JSON-safe maps for tool replies.

Minimal BB-DSL robot used solely for compile-time introspection in the bb_mcp test suite. It is not intended to be started — only BB.Dsl.Info.commands/1 and friends are exercised against it.

Converts BB command argument definitions into JSON Schema fragments.

Converts BB command argument definitions into Peri schemas suitable for Anubis.Server.Frame.register_tool/3.

Shared helpers for the resource component modules under BB.MCP.Resources.*.

Declared commands on a robot, with typed argument schemas.

Index of all configured robots exposed by this MCP server.

Current joint positions and velocities of a robot, in SI base units (metres or radians for position, m/s or rad/s for velocity).

All runtime parameters registered on a robot, with their current values.

Current operational and safety state of a robot.

Static topology of a robot — links, joints, sensors, and actuators.

Resolves between agent-facing robot name strings and robot modules.

Phoenix router macro for mounting the BB MCP server over Streamable HTTP.

MCP server that exposes BB robots to AI agents.

Shared logic used by the per-tool component modules under BB.MCP.Tools.*.

Force-disarm a robot from :error state.

Read a single runtime parameter from a robot.

Get the current operational and safety state of a robot.

List the commands declared on a robot, with their typed argument schemas.

List the runtime parameters registered on a robot, optionally filtered by a path prefix.

List the robots this MCP server is configured to expose.

Query pubsub events captured by the current MCP session.

Send target positions to one or more robot joints.

Write a single runtime parameter on a robot.

Mix Tasks

Installs BB.MCP into an application