Skip to main content
Glama
Sign In
pico-bay

pico-bay

Official
by ctrlpi
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

Install the ctrlPi API on a board

pico_ctrlpi_install
Destructive

Install or update the ctrlPi API agent on Pico W, Pico 2 W, ESP32, ESP32-S3, or ESP32-C3 MicroPython boards, configure Wi-Fi/API settings, and reset the board.

Instructions

Install or update the ctrlPi API agent on a Pico W, Pico 2 W, ESP32, ESP32-S3 or ESP32-C3 running MicroPython (pico-gpio-api or esp32-gpio-api, downloaded from GitHub). Writes app.mpy, upgrader.mpy and main.py (plus boot.py on an ESP32), then config.json (the board's own kept, with this api_key and name), wifi.txt and scripts/cpu-temp.py when missing, and resets the board. It replaces main.py, so ask the user first and pass confirmed: true.

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": {
      "board_id": "<board_id>",
      "wifi_ssid": "<wifi_ssid>",
      "confirmed": "<confirmed>"
    },
    "name": "pico_ctrlpi_install"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoAgent name. Left out: the board's own name, else the agent's pico-<serial4> or esp32-<serial4> default; an empty string resets it to that default.
api_keyNoAgent API key. Left out: the board's own key, else your-secret-key (public, so change it).
board_idYesStable board UID returned by pico_boards_list, or its current serial device path.
confirmedYesMust be true after the user explicitly confirms the install.
wifi_ssidYesWi-Fi network the agent joins.
wifi_passwordNoWi-Fi password (empty for an open network).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

The annotations already mark this as destructive and not read-only, but the description adds substantial behavioral detail: exact files written, preservation of the board's own config.json, creation of missing wifi.txt and scripts/cpu-temp.py, and a board reset. It also clearly discloses that main.py is replaced and that user confirmation is required before calling.

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?

The purpose and target platforms are front-loaded, followed by the file-level effects and the confirmation warning. It is dense and information-rich with little wasted wording, though the long file-list sentence could be easier to scan.

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

Completeness4/5

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

For a destructive installer with no output schema, the description covers the important context: supported boards, MicroPython prerequisite, files modified or preserved, reset behavior, and confirmation. It leaves some gaps around failure behavior, rollback, and return/status reporting.

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

Parameters4/5

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

Schema coverage is 100%, so the schema already explains every parameter and the baseline would be 3. The description still adds meaning by clarifying that name and api_key are persisted in config.json and that Wi-Fi fields support wifi.txt, while reinforcing confirmed as the post-user-approval flag.

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?

The description states a specific verb and resource: install or update the ctrlPi API agent on named Pico and ESP32 boards running MicroPython. It distinguishes this from the generic pico_install sibling by naming the ctrlPi API and the pico-gpio-api/esp32-gpio-api packages.

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

Usage Guidelines4/5

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

It gives a clear prerequisite (MicroPython on a supported board) and a mandatory confirmation workflow: ask the user first and pass confirmed: true. It does not explicitly say when to choose this over pico_install or when not to use it, so it falls short of full alternative guidance.

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

Deploy Server

Other Tools