Skip to main content
Glama

Get product request

get_product_request
Read-only

Get a product request. scope=mine (default) returns your request including workflow history and safety status. scope=public returns another user's public request with only public platform/environment options; owner identity, private details and safety/review notes are omitted. Capture progress is exposed without job IDs. requestId is returned by create_product_request or list_product_requests.

Input Schema

NameRequiredDescriptionDefault
scopeNomine (default) returns your requests; public returns other users public requests with private and safety details omitted.mine
requestIdYesUUID returned by create_product_request or list_product_requests. The request must be visible in the selected scope.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • 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 / scope / description
      Added value: +"mine (default) returns your requests; public returns other users public requests with private and safety details omitted."
    • 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"
      +    },
      +    "publicRequest": {
      +      "additionalProperties": false,
      +      "description": "Other user public request with private review/safety fields omitted",
      +      "properties": {
      +        "createdAt": {
      +          "description": "ISO-8601 timestamp",
      +          "type": "string"
      +        },
      +        "history": {
      +          "description": "Result entries",
      +          "items": {
      +            "$ref": "#/$defs/requestHistory"
      +          },
      +          "type": "array"
      +        },
      +        "payloadJson": {
      +          "description": "payloadJson",
      +          "type": "string"
      +        },
      +        "product": {
      +          "description": "product",
      +          "type": "string"
      +        },
      +        "requestId": {
      +          "description": "requestId",
      +          "type": "string"
      +        },
      +        "requestType": {
      +          "description": "requestType",
      +          "type": "string"
      +        },
      +        "status": {
      +          "description": "status",
      +          "type": "string"
      +        },
      +        "subject": {
      +          "description": "subject",
      +          "type": "string"
      +        },
      +        "url": {
      +          "description": "url",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "requestId",
      +        "requestType",
      +        "product",
      +        "subject",
      +        "url",
      +        "status",
      +        "payloadJson",
      +        "createdAt",
      +        "history"
      +      ],
      +      "type": "object"
      +    },
      +    "request": {
      +      "anyOf": [
      +        {
      +          "$ref": "#/$defs/privateRequest"
      +        },
      +        {
      +          "$ref": "#/$defs/publicRequest"
      +        }
      +      ],
      +      "description": "Request fields vary with mine/public scope"
      +    },
      +    "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": {
      +      "$ref": "#/$defs/request"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, and the description adds real behavioral context on top: public scope omits owner identity, private details and safety/review notes, and capture progress is surfaced without job IDs. That goes beyond what the annotation provides.

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 description is front-loaded with the core purpose, then layers in scope behavior and provenance in compact sentences. It is slightly repetitive with the schema text but has no filler sentences.

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?

An output schema exists, so return-value detail is not required, and the description still covers both scope modes, the visibility restrictions, and where requestId comes from. It is essentially complete for a read tool of this complexity, with only inter-sibling routing left implicit.

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 100%, so both parameters are already documented, and the description largely restates the scope semantics and the requestId provenance. The baseline 3 applies because the description adds little parameter meaning the schema does not already carry.

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 ('Get a product request') and clarifies the two visibility modes. It also names the siblings that produce the requestId (create_product_request, list_product_requests), giving partial differentiation without a full contrast against wait_product_request or get_request_options.

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?

Explains the scope=mine vs scope=public selection and what each returns, which effectively tells an agent when to pick each mode. It stops short of stating when to prefer this tool over list_product_requests or wait_product_request, so it is clear context rather than full when/when-not guidance.

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