ui_start

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

With no annotations, the description carries the disclosure burden. It usefully reveals the fallback behavior when web-dist is missing (build or use the Docker image). However, it does not disclose whether the start call blocks, starts a background server, or what side effects or prerequisites exist beyond web-dist.

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

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

Two concise sentences with no filler. The main action is front-loaded and the conditional fallback is stated in a single additional sentence, making the description easy to parse quickly.

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

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

The tool is simple, with one optional parameter and no output schema, so the description covers the core action and a key prerequisite. Still, it omits useful context such as how to stop the editor, whether the process stays alive, or what a successful start returns.

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

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

Schema description coverage is 0%, so the description should compensate for parameter meaning. It does not mention the port parameter at all, though the schema itself provides type, default, and range. The description adds no semantic value beyond the schema's minimal definition.

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

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

The description states a specific verb (Start), a resource (local editor), and a location (127.0.0.1). It clearly identifies the tool's purpose and differentiates it from media, rendering, and captioning siblings without needing to open the schema.

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

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

The intended use is implied: call this when you need the local editor running. It also gives conditional guidance about web-dist and Docker, but it does not explicitly state when not to use it or mention the companion ui_stop tool for stopping the editor.

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