Skip to main content
Glama

script_explain

Read-onlyIdempotent

Explain a cubicle.script v1 as the runner compiled it: its kind (strategy or indicator), inputs with bounds, fields with their types, states, what it draws and its budget, every order (the transition it sits on, where it fills: close, next_open, limit() or stop(), its stop, target and trail), the fill model it declares, and the same in plain lines to say to the trader. Or pass code (C050) for what one diagnostic code means. Nothing runs. Free.

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

Input Schema

NameRequiredDescriptionDefault
codeNoa diagnostic code to explain instead, such as C050
scriptNothe cubicle.script v1 YAML text

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive and closed-world, but the description adds two things they cannot: "Nothing runs" (no execution, no side effects) and "Free" (no credit cost), which materially affect an agent's willingness to call it. It also discloses the shape of the returned explanation, compensating for the absent output schema. The gap is that it never says what happens if neither `script` nor `code` is supplied.

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 purpose is front-loaded in the first clause and the two short trailing sentences (code mode, "Nothing runs. Free.") carry high value per word. The middle enumeration is dense and stacks nested parentheses like limit(<price>), which slows parsing, but with no output schema each listed item is doing necessary work.

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 carries the burden of describing return content and does so thoroughly, including order fill semantics and the plain-language summary to the trader. Annotations cover the safety profile. The one missing piece is edge-case behavior when no argument is passed, which matters because zero parameters are required.

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%, so the baseline is 3; the description adds mode-level meaning by explaining that `code` switches the tool to explaining a single diagnostic and giving a concrete example (C050), and that `script` is the YAML text whose compilation is explained. It implies the parameters are alternatives but never states they are mutually exclusive or which wins if both are given.

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 ("Explain a cubicle.script v1") and then enumerates exactly what the explanation contains: kind, inputs with bounds, fields, states, draws and budget, orders, fill model, plus plain-language lines. It also carves out a second mode via the `code` parameter. It does not name any sibling (e.g. script_validate or script_rehearse) to differentiate itself, 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 Guidelines4/5

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

The "Or pass `code` (C050) for what one diagnostic code means" clause gives explicit mode-selection guidance with an example code, which is the key ambiguity for a two-parameter, zero-required tool. It does not state when to prefer this over validating or rehearsing a script, so it lacks exclusions/alternatives by name.

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