Skip to main content
Glama

Describe Example

describe_example
Read-only

Inspect an exact playable-example ref returned by list_examples. Returns dependencies and assets while omitting the full internal graph; does not load or play anything. Fails explicitly when detail exceeds 256 KiB.

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": {
      "schema_version": "<schema_version>",
      "ref": "<ref>"
    },
    "name": "describe_example"
  }
}

Input Schema

NameRequiredDescriptionDefault
refYes
schema_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Beyond readOnlyHint=true, it discloses what the response contains (dependencies and assets), what it deliberately omits (the full internal graph), that no loading or playback occurs, and a concrete failure mode with a 256 KiB threshold. That is substantive behavioral context, though the failure output shape is left unstated.

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?

Three short sentences, front-loaded with provenance and scope, then return contents, then the failure bound. No filler or restatement of the name.

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 return-value burden and does describe the payload at a high level plus the size limit and error behavior. Minor gaps remain around the undocumented schema_version parameter and the shape of the failure response.

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 reported as 0%, so the description must compensate. It does add real meaning for 'ref' by requiring an exact ref returned by list_examples (not a SemVer-style or arbitrary coordinate), but the second parameter schema_version is given no explanation anywhere.

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

Purpose5/5

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

States a specific verb (inspect) applied to a specific resource (an exact playable-example ref), and ties the input's provenance to the sibling list_examples, which is the tool that produces it. An agent can tell this apart from list_examples without inspecting either schema.

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?

Explicitly anchors usage to refs returned by list_examples, and the clause 'does not load or play anything' implicitly routes playback elsewhere (play_preview). It stops short of naming the alternative outright, so the exclusion is inferential rather than spelled out.

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