Skip to main content
Glama

RegLayer Instant Decision Briefs

Get structured Instant Brief

get_instant_brief_result
Read-onlyIdempotent

Read the structured result after status reaches ready. If still researching, close the call and retry after 20 seconds.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
order_idYesThe order_id returned by the paid Instant Brief purchase request.
access_tokenYesThe private RegLayer access token returned with the order. Send it only to RegLayer and never expose it to the end user.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okNoWhether the private status request succeeded.
errorNoA machine-readable error label when the request cannot be completed.
noticeNoThe notice that must travel with RegLayer research outputs.
resultNoThe complete structured Decision Brief when research is ready.
statusNoThe current order state, such as researching, ready, or failed.
messageNoA human-readable status, authentication, or not-ready message.
productNoThe purchased Instant Brief product code.
brief_idNoThe Decision Brief identifier used in the finished artifact.
order_idNoThe private RegLayer order identifier.
referenceNoThe customer-facing brief reference.
api_versionNoThe version of the RegLayer agent delivery contract.
result_kindNoThe type of structured artifact returned.
published_atNoThe timestamp when the result became available.
delivery_modeNoThe asynchronous delivery pattern used for this order.
result_versionNoThe version of the stored structured result.
poll_after_secondsNoSeconds to wait before the next status check, or null when no further polling is needed.
connection_requiredNoWhether the original connection must remain open.
delivery_instructionsNoInstructions for retrieving the result without relying on email.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / order_id / description
      Previous value: -"The order_id returned by the paid Instant Decision Brief purchase request."New value: +"The order_id returned by the paid Instant Brief purchase request."
    • changedOutput schema / properties / product / description
      Previous value: -"The purchased Instant Decision Brief product code."New value: +"The purchased Instant Brief product code."
  2. Changed3 schema fields changed
    • addedInput schema / properties / access_token / description
      Added value: +"The private RegLayer access token returned with the order. Send it only to RegLayer and never expose it to the end user."
    • addedInput schema / properties / order_id / description
      Added value: +"The order_id returned by the paid Instant Decision Brief purchase request."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "api_version": {
      +      "description": "The version of the RegLayer agent delivery contract.",
      +      "type": "string"
      +    },
      +    "brief_id": {
      +      "description": "The Decision Brief identifier used in the finished artifact.",
      +      "type": "string"
      +    },
      +    "connection_required": {
      +      "description": "Whether the original connection must remain open.",
      +      "type": "boolean"
      +    },
      +    "delivery_instructions": {
      +      "description": "Instructions for retrieving the result without relying on email.",
      +      "type": "string"
      +    },
      +    "delivery_mode": {
      +      "description": "The asynchronous delivery pattern used for this order.",
      +      "type": "string"
      +    },
      +    "error": {
      +      "description": "A machine-readable error label when the request cannot be completed.",
      +      "type": "string"
      +    },
      +    "message": {
      +      "description": "A human-readable status, authentication, or not-ready message.",
      +      "type": "string"
      +    },
      +    "notice": {
      +      "description": "The notice that must travel with RegLayer research outputs.",
      +      "type": "string"
      +    },
      +    "ok": {
      +      "description": "Whether the private status request succeeded.",
      +      "type": "boolean"
      +    },
      +    "order_id": {
      +      "description": "The private RegLayer order identifier.",
      +      "type": "string"
      +    },
      +    "poll_after_seconds": {
      +      "anyOf": [
      +        {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Seconds to wait before the next status check, or null when no further polling is needed."
      +    },
      +    "product": {
      +      "description": "The purchased Instant Decision Brief product code.",
      +      "type": "string"
      +    },
      +    "published_at": {
      +      "description": "The timestamp when the result became available.",
      +      "type": "string"
      +    },
      +    "reference": {
      +      "description": "The customer-facing brief reference.",
      +      "type": "string"
      +    },
      +    "result": {
      +      "additionalProperties": {},
      +      "description": "The complete structured Decision Brief when research is ready.",
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "result_kind": {
      +      "description": "The type of structured artifact returned.",
      +      "type": "string"
      +    },
      +    "result_version": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "number"
      +        }
      +      ],
      +      "description": "The version of the stored structured result."
      +    },
      +    "status": {
      +      "description": "The current order state, such as researching, ready, or failed.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already convey readOnly, idempotent, and non-destructive behavior. The description adds the retry condition and the 'still researching' state, which is valuable context beyond the annotations. No contradiction with annotations.

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 a concise two-sentence statement that directly states the purpose and the retry instruction without any fluff. It is front-loaded and effective.

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

Completeness5/5

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

With a comprehensive input schema, an output schema available, annotations covering safety, and a description that includes when to use and retry, the tool is fully contextualized. The sibling tools further clarify differentiation.

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?

The input schema provides full descriptions for both parameters (order_id and access_token) at 100% coverage, so the description does not need to add detail. It contributes no additional parameter semantics, but the baseline is 3 given complete schema coverage.

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?

The description clearly states the action ('Read') and the resource ('structured result' of an Instant Brief) and specifies a prerequisite condition ('after status reaches ready'). It is distinct from siblings like get_instant_brief_pdf (likely PDF) and get_instant_brief_status (likely status only).

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 description provides clear timing guidance for when to call (after status ready) and includes a retry instruction ('close the call and retry after 20 seconds'). It does not explicitly name alternative tools for when not to use it, but the sibling context makes the intended usage obvious.

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