Skip to main content
Glama

Get preview

get_preview
Idempotent

Start the preview if needed and return the public URL. healthy:false means the app isn't answering yet: check get_logs, fix the code, and don't loop restarts.

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": "get_preview"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idNoProject id (or use session from use_project)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Goes beyond the annotations by disclosing that it starts the preview on demand, exposes a public URL, and surfaces a healthy flag whose false value is a signal rather than a hard error. The explicit anti-restart-loop warning is valuable operational context that no annotation conveys. It omits details like propagation delay or what happens when the preview is already running and healthy.

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 action and return value, followed by the one failure mode that matters. No filler.

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?

With no output schema, the description usefully names the returned public URL and the healthy field. It is complete enough to call correctly, though it doesn't describe the remaining response fields or timing expectations for a cold start.

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

Parameters3/5

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

The single project_id parameter is fully documented in the schema, including the session-based alternative, so the baseline is 3. The description adds no further parameter meaning beyond the schema.

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

Purpose4/5

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

States a specific verb and resource: start the preview if needed and return its public URL. This distinguishes it from a pure start operation by the idempotent framing, though it never names a sibling explicitly.

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 concrete routing for the failure path: healthy:false means check get_logs, fix the code, and avoid restart loops. That is real when-to-use-which guidance, but it doesn't cover the success path or when to prefer start_preview/stop_preview.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources