Skip to main content
Glama

run_generate

Renders previews into a static gallery bundle, keeping output from crashed previews and reporting failures by file and line. Limit rendering to changed or specified files for faster iteration.

Instructions

Run the platform engine to render all previews and produce a bundle (manifest + images), same as phonebook generate. When previews crash, keeps what rendered and says which previews did not, by file and line. Pass changed or files to render only the previews declared in those files, for a faster loop while iterating.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dirNoProject directory containing phonebook.config.json.
filesNoRender only previews declared in these files, relative to the project directory.
changedNoRender only previews declared in files with uncommitted git changes. Ignored outside a git repository.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.7
    • addedInput schema / properties / changed
      Added value: +{
      +  "description": "Render only previews declared in files with uncommitted git changes. Ignored outside a git repository.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / files
      Added value: +{
      +  "description": "Render only previews declared in these files, relative to the project directory.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  2. First observedv0.1.2

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations provided, the description must carry the full burden of behavioral disclosure. It does disclose crash handling (keeps what rendered, reports failures by file and line) and the bundle output, which is valuable. However, it omits other behavioral traits like side effects, idempotency, and prerequisites, leaving significant gaps.

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?

The description is three sentences with no filler. It front-loads the core purpose, then adds crash behavior and usage tips. Every sentence earns its place and the structure is clean.

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

Completeness3/5

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

The tool has no output schema and no annotations, so the description should clarify return values and side effects. It mentions the bundle output but does not specify what the tool returns to the agent. It also does not state prerequisites like the config file beyond the dir parameter, leaving completeness gaps.

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?

All three parameters are fully described in the schema (100% coverage), so the description adds little beyond what is already structured. It mentions passing files or changed but does not elaborate on their semantics beyond the schema's descriptions.

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?

The description clearly states the tool runs the platform engine to render previews and produce a bundle, referencing 'phonebook generate' for familiarity. It does not explicitly distinguish from sibling tools like run_build, but the core action is unambiguous and specific.

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 provides clear guidance on using the files and changed parameters to limit rendering to specific files for a faster iteration loop. However, it does not mention when to use this tool over siblings or any exclusions, so it falls short of a 5.

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