Skip to main content
Glama

Open or stop the pi-bay web UI

pi_ui

Open the pi-bay web UI for devices, files, and terminal in your browser, starting its web server if needed; stop only a server this tool started.

Instructions

Open the pi-bay web UI (devices, files, terminal) in the browser, starting its web server when needed (action open, the default). When pi-bay runs on a Raspberry Pi or another remote machine it cannot open the user's browser: the result then has opened: false, and url is the address to open in a browser on the user's computer. Action stop stops a web server this tool started; the pi-bay app itself is never stopped.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "pi_ui"
  }
}

Input Schema

NameRequiredDescriptionDefault
actionNoopen (default) or stop.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.9.40

TDQS

A4.7/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: it starts a web server as a side effect, 'stop' only affects servers this tool started, the pi-bay app itself is never stopped, and on remote hosts the result carries opened: false with url as the browser address. This directly addresses the mutation implications flagged by readOnlyHint=false and destructiveHint=false.

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

Conciseness5/5

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

Two sentences, front-loaded with the primary action and its default, followed by the failure-mode behavior and the secondary action. No redundant restatement of the tool name or enum values.

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?

With only one optional enum parameter and no output schema, the description is complete: it covers both actions, the default, side effects, stop scope, and even the shape of the result in the remote case. Nothing an agent needs to invoke or interpret this tool correctly is missing.

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% and the enum already documents 'open' and 'stop', so the schema does the baseline work. The description still adds meaning by declaring 'open' the default despite the parameter being optional, and by clarifying that 'stop' targets only tool-started servers rather than the app.

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 ('Open the pi-bay web UI ... in the browser') with the scope in parentheses (devices, files, terminal), and separately defines the second mode ('Action stop stops a web server this tool started'). An agent can distinguish this from the command/file/device siblings without opening the schema.

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?

Gives clear usage context: 'open' is explicitly the default, and 'stop' is scoped to servers this tool started. The remote-machine case is also explained so the agent knows when to relay a URL instead of assuming a browser opened. It stops short of naming an alternative tool for reading files or running commands, so no explicit exclusions.

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