Skip to main content
Glama

rex_api_describe

Retrieves the schema and examples for a single Rex API method, so you can inspect its parameters and expected responses before making calls.

Instructions

Schemas and examples for one API method (rex api describe --json).

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": {
      "method": "<method>"
    },
    "name": "rex_api_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
methodYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior2/5

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

No annotations and no output schema, so the description carries the full burden. It does disclose the return content ('schemas and examples'), which is meaningful, but says nothing about behavior for an unknown/malformed method name, error handling, or whether this only reads metadata.

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?

One short sentence with the resource front-loaded and no wasted words; the CLI-style parenthetical adds little but is harmless. Brevity occasionally crosses into under-specification rather than efficient concision.

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?

For a one-parameter metadata lookup with no output schema, the description covers the essential idea but leaves the method-string format and failure behavior unexplained, which an agent needs to invoke it reliably.

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 coverage is 0% for the single 'method' parameter, so the description must compensate. It partially does by identifying the parameter's role (one API method identifier), but gives no format guidance (e.g., dotted method name or namespace) for supplying it correctly.

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 resource: schemas and examples for a single API method, which is clearly distinct from rex_api_call (invoke a method) and rex_api_list (enumerate methods). The verb is implicit in 'describe', but an agent can tell what it retrieves without opening the schema.

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 only implied by the phrase 'for one API method' — an agent can infer this is a lookup used before calling rex_api_call, but no explicit when-to-use, prerequisite, or alternative (e.g., rex_api_list for discovery) is named.

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