Skip to main content
Glama

gc_hardware_register

Register a real GameCube hardware instance to persist its capture device, serial ports, and BBA network settings for later ROM loading and control.

Instructions

Register a real GameCube hardware instance.

A hardware instance represents a physical console that stays connected to this host. It is permanently remembered (persisted to the server's data dir) until it is explicitly removed with gc_hardware_remove.

Args: instance_id: Unique id for the hardware instance (e.g. hw-001). capture_device: Video4Linux2 device path (default /dev/video0). Prefer a device reported with can_capture: true by gc_hardware_devices. capture: Optional capture options, e.g. {"width": 640, "height": 480, "format": "mjpg", "fps": 30, "flush_frames": 5, "warmup_seconds": 5, "warmup_ttl": 60}. warmup_seconds is how long a cold capture card is streamed before grabbing a frame (0 disables). serial_devices: Up to four serial device paths that will act as the GameCube controller ports (0-3). Controller driving is not yet implemented, but the devices are remembered. bba_ip: The console's own BBA IP (e.g. 192.0.2.10), used by gc_rom_load to reach the Swiss netboot listener. bba_port: The netboot listener port (default 4242). info: Free-form description/annotation shown in list and status output.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "instance_id": "<instance_id>"
    },
    "name": "gc_hardware_register"
  }
}

Input Schema

NameRequiredDescriptionDefault
infoNo
bba_ipNo
captureNo
bba_portNo
instance_idYes
capture_deviceNo
serial_devicesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations at all, the description carries the full behavioral burden and does substantial work: it discloses that state is permanently persisted to the server's data dir until explicitly removed, and honestly notes that controller driving via serial_devices is not yet implemented even though the devices are remembered. It stops short of describing conflict/overwrite behavior on re-registration or required host permissions for device access.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and its persistence semantics, then a structured Args block, so a skimming agent gets the essentials first. The capture options inline example is long but each sub-key conveys real meaning; minor slack in the parenthetical aside about controller driving.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter creation tool with no annotations and no output schema, everything an agent needs to call it correctly is present: required vs optional split is visible in the schema, persistence and lifecycle are described, unimplemented functionality is flagged, and the dependency on gc_rom_load's use of bba_ip is explained.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and there are 7 parameters, so the description must compensate — and it does. Every parameter is explained with examples and defaults: instance_id format (hw-001), capture_device default path plus how to choose it, capture options broken out with warmup_seconds semantics and the meaning of 0, serial_devices mapped to controller ports 0-3, bba_ip tied to the Swiss netboot listener, bba_port default 4242, and info's role in list/status output.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: registering a real GameCube hardware instance that is persisted to the server's data dir. It also names the removal sibling (gc_hardware_remove) and the device-discovery sibling (gc_hardware_devices), so an agent can tell it apart from gc_hardware_update/list/status without opening another schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied rather than stated: register once, then the instance persists until removed. It gives a helpful precondition for one parameter (prefer a device reported with can_capture: true by gc_hardware_devices) and points at gc_rom_load as the consumer of bba_ip. However, it never says when to use this versus gc_hardware_update for an already-registered instance, nor what happens on duplicate instance_id.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.