Skip to main content
Glama

Wait for product request

wait_product_request
Read-only

Wait up to 30 seconds for your request status to change. Pass progressStatus from the last result as knownStatus to follow verification and capture progress. Polls fresh repository data every two seconds; returns changed, terminal and timedOut plus request. Completed, failed, canceled and rejected are terminal. Legacy pending/approved/rejected values retain review-only waiting. Capture progress is exposed without job IDs. Repeat after timeout while the user wants to wait; do not resubmit the request.

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": {
      "requestId": "<requestId>",
      "knownStatus": "<knownStatus>"
    },
    "name": "wait_product_request"
  }
}

Input Schema

NameRequiredDescriptionDefault
requestIdYesUUID returned by create_product_request or list_product_requests. The request must be visible in the selected scope.
knownStatusYesprogressStatus from the previous request result. Legacy pending, approved and rejected values wait on review status only.
waitSecondsNoMaximum wait duration in seconds, clamped to 0..30; default 20. Zero performs one immediate status check.

Output Schema

NameRequiredDescriptionDefault
changedYesWhether this condition holds
requestYes
terminalYesWhether this condition holds
timedOutYesWhether this condition holds

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +true
    • changedOutput schema / description
      Previous value: -"Structured result. Existing text or image content remains available in content."New value: +"Owner request polling result"
    • addedOutput schema / properties / changed
      Added value: +{
      +  "description": "Whether this condition holds",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / request
      Added value: +{
      +  "$ref": "#/$defs/privateRequest"
      +}
    • removedOutput schema / properties / result
      Removed value: -{
      -  "additionalProperties": true,
      -  "description": "Owner request polling result",
      -  "properties": {
      -    "changed": {
      -      "description": "Whether this condition holds",
      -      "type": "boolean"
      -    },
      -    "request": {
      -      "$ref": "#/$defs/privateRequest"
      -    },
      -    "terminal": {
      -      "description": "Whether this condition holds",
      -      "type": "boolean"
      -    },
      -    "timedOut": {
      -      "description": "Whether this condition holds",
      -      "type": "boolean"
      -    }
      -  },
      -  "required": [
      -    "request",
      -    "changed",
      -    "terminal",
      -    "timedOut"
      -  ],
      -  "type": "object"
      -}
    • addedOutput schema / properties / terminal
      Added value: +{
      +  "description": "Whether this condition holds",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / timedOut
      Added value: +{
      +  "description": "Whether this condition holds",
      +  "type": "boolean"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "result"
      -]New value: +[
      +  "request",
      +  "changed",
      +  "terminal",
      +  "timedOut"
      +]
  2. Changed4 schema fields changed
    • addedInput schema / properties / knownStatus / description
      Added value: +"progressStatus from the previous request result. Legacy pending, approved and rejected values wait on review status only."
    • addedInput schema / properties / requestId / description
      Added value: +"UUID returned by create_product_request or list_product_requests. The request must be visible in the selected scope."
    • addedInput schema / properties / waitSeconds / description
      Added value: +"Maximum wait duration in seconds, clamped to 0..30; default 20. Zero performs one immediate status check."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "privateRequest": {
      +      "additionalProperties": false,
      +      "description": "Authenticated owner request including review and capture progress",
      +      "properties": {
      +        "createdAt": {
      +          "description": "ISO-8601 timestamp",
      +          "type": "string"
      +        },
      +        "history": {
      +          "description": "Result entries",
      +          "items": {
      +            "$ref": "#/$defs/requestHistory"
      +          },
      +          "type": "array"
      +        },
      +        "jobStatus": {
      +          "description": "jobStatus",
      +          "type": "string"
      +        },
      +        "payloadJson": {
      +          "description": "payloadJson",
      +          "type": "string"
      +        },
      +        "product": {
      +          "description": "product",
      +          "type": "string"
      +        },
      +        "progressStatus": {
      +          "description": "progressStatus",
      +          "type": "string"
      +        },
      +        "requestId": {
      +          "description": "requestId",
      +          "type": "string"
      +        },
      +        "requestType": {
      +          "description": "requestType",
      +          "type": "string"
      +        },
      +        "reviewedAt": {
      +          "anyOf": [
      +            {
      +              "description": "ISO-8601 timestamp",
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "safetyStatus": {
      +          "description": "safetyStatus",
      +          "type": "string"
      +        },
      +        "status": {
      +          "description": "status",
      +          "type": "string"
      +        },
      +        "subject": {
      +          "description": "subject",
      +          "type": "string"
      +        },
      +        "url": {
      +          "description": "url",
      +          "type": "string"
      +        },
      +        "workflowStatus": {
      +          "description": "workflowStatus",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "requestId",
      +        "requestType",
      +        "product",
      +        "subject",
      +        "url",
      +        "status",
      +        "payloadJson",
      +        "createdAt",
      +        "history",
      +        "safetyStatus",
      +        "workflowStatus",
      +        "jobStatus",
      +        "progressStatus",
      +        "reviewedAt"
      +      ],
      +      "type": "object"
      +    },
      +    "requestHistory": {
      +      "additionalProperties": true,
      +      "description": "Public workflow transition",
      +      "properties": {
      +        "actor": {
      +          "description": "actor",
      +          "type": "string"
      +        },
      +        "at": {
      +          "description": "ISO-8601 timestamp",
      +          "type": "string"
      +        },
      +        "reason": {
      +          "description": "reason",
      +          "type": "string"
      +        },
      +        "status": {
      +          "description": "status",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "status",
      +        "reason",
      +        "actor",
      +        "at"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": false,
      +  "description": "Structured result. Existing text or image content remains available in content.",
      +  "properties": {
      +    "result": {
      +      "additionalProperties": true,
      +      "description": "Owner request polling result",
      +      "properties": {
      +        "changed": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "request": {
      +          "$ref": "#/$defs/privateRequest"
      +        },
      +        "terminal": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        },
      +        "timedOut": {
      +          "description": "Whether this condition holds",
      +          "type": "boolean"
      +        }
      +      },
      +      "required": [
      +        "request",
      +        "changed",
      +        "terminal",
      +        "timedOut"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the readOnlyHint annotation: it discloses the polling interval (every two seconds), the maximum wait, the return fields (changed, terminal, timedOut, request), which statuses are terminal, and how legacy pending/approved/rejected behave. It also notes capture progress is returned without job IDs, which the agent could not infer from annotations or schema.

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?

Front-loaded with the primary behavior and capped at a handful of sentences, most of which carry distinct information. A few clauses are telegraphic, such as 'Capture progress is exposed without job IDs', which is a little opaque for the value it adds.

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?

For a bounded long-poll with three parameters and an output schema, the description covers timing, terminal conditions, the repeat-on-timeout loop, and the anti-pattern of resubmitting. Nothing material is missing for an agent to call it correctly.

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 schema already documents all three parameters and the baseline would be 3. The description adds cross-call meaning by tying knownStatus to 'progressStatus from the last result', which is the non-obvious contract that makes the long-poll work.

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 and resource with scope: 'Wait up to 30 seconds for your request status to change.' It clearly distinguishes itself from get_product_request (single fetch) and list_product_requests by being a bounded long-poll that follows status transitions.

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?

Gives concrete usage context: pass progressStatus from the last result as knownStatus to follow verification and capture progress, repeat after timeout while the user still wants to wait, and do not resubmit the request. It stops short of explicitly naming get_product_request or list_product_requests as the alternative for a one-off check, leaving that inference to the agent.

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