Skip to main content
Glama

Get a promo

get_promo
Read-only

A promo's state, in brief: what it has and needs, its lines, a still per scene, the checks, the draft's watch link, the finals and the price of each size. detail: true adds each screen's cards (region ids and text), the shelf's sources, the recipe changes and what each price covers. Waits up to wait_seconds while it is working. Free.

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": {
      "promo_id": "<promo_id>"
    },
    "name": "get_promo"
  }
}

Input Schema

NameRequiredDescriptionDefault
detailNoAdd each screen's cards (region ids and text), the shelf's sources, the recipe changes and what each price covers; left out, the promo comes in brief
promo_idYesThe promo's id, from make_promo
wait_secondsNoHow long to wait while it is working (default 30)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Consistent with readOnlyHint=true, and the description adds real behavior the annotation cannot: the call blocks up to wait_seconds while work is in progress, detail=true widens the payload substantially, and the call is free. Return shape is summarized rather than dumped. It does not say what happens on timeout or when the promo is incomplete, keeping it off a 5.

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 payload summary is front-loaded and dense; the terse fragment style ('Free.') conveys cost cheaply. The noun-list opening sentence is heavy to parse but every clause maps to an actual returned field, so little is wasted.

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 correctly carries the burden of describing return values and does so across both brief and detail modes. The only real gap for a read tool with a blocking wait is timeout/error behavior.

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?

Schema description coverage is 100%, so baseline is 3, and the description largely restates the schema wording for detail and wait_seconds rather than adding new meaning. Marginal gain is framing wait_seconds as a blocking wait rather than a timeout.

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 opens with a specific resource and verb framing ('A promo's state, in brief') and then enumerates the returned surface: lines, per-scene stills, checks, draft watch link, finals, per-size pricing. That is far more than a restatement of the name. It does not distinguish itself from retrieval siblings like preview_promo or get_render, so it stops short of a 5.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: 'Waits up to wait_seconds while it is working' signals this is the polling/status call, and 'Free' signals it is the cheap option to reach for. There is no explicit when-to-use versus preview_promo or get_render, and no stated preconditions beyond the promo_id schema note pointing at make_promo.

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