Skip to main content
Glama

Create product request

create_product_request

Submit a product capture request for the authenticated user. requestType=add requires a public HTTPS url and an empty product; subject is optional. requestType=update requires an existing published product key; backend derives its name and source URL. Select platform/environment from get_request_options. Creates a pending request, not an immediate capture. Subscription, URL safety and duplicate checks apply. Call only when the user asks to submit a request; do not automatically submit while browsing missing captures.

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": {
      "requestType": "<requestType>",
      "platform": "<platform>",
      "environment": "<environment>"
    },
    "name": "create_product_request"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoPublic HTTPS URL to capture for requestType=add. Leave empty for update, whose source URL is derived by the backend; default empty.
productNoPublished product key for requestType=update. Leave empty for requestType=add; default empty.
subjectNoOptional title for an add request. Default empty; the backend derives the title for updates.
platformYesRequest platform ID from get_request_options.platforms[].id. Use the returned ID verbatim; availability may be narrower than capture platforms.
environmentYesRequest environment ID from the selected get_request_options platform environments[].id. Use the returned ID verbatim.
payloadJsonNoOptional request-specific settings encoded as a JSON string. Default empty. Platform and environment are supplied separately and validated by the backend.
requestTypeYesCapture request type: add for a new public HTTPS URL, or update for an existing published product.
webExtensionUrlNoChrome Web Store link when adding a Web Extension product. Updates use the existing product source.

Output Schema

NameRequiredDescriptionDefault
urlYesurl
statusYesstatus
historyYesResult entries
productYesproduct
subjectYessubject
createdAtYesISO-8601 timestamp
jobStatusYesjobStatus
requestIdYesrequestId
reviewedAtYes
payloadJsonYespayloadJson
requestTypeYesrequestType
safetyStatusYessafetyStatus
progressStatusYesprogressStatus
workflowStatusYesworkflowStatus

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed19 schema fields changed
    • addedInput schema / properties / requestType / enum
      Added value: +[
      +  "add",
      +  "update"
      +]
    • removedOutput schema / $defs / privateRequest
      Removed value: -{
      -  "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"
      -}
    • changedOutput schema / description
      Previous value: -"Structured result. Existing text or image content remains available in content."New value: +"Authenticated owner request including review and capture progress"
    • addedOutput schema / properties / createdAt
      Added value: +{
      +  "description": "ISO-8601 timestamp",
      +  "type": "string"
      +}
    • addedOutput schema / properties / history
      Added value: +{
      +  "description": "Result entries",
      +  "items": {
      +    "$ref": "#/$defs/requestHistory"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / jobStatus
      Added value: +{
      +  "description": "jobStatus",
      +  "type": "string"
      +}
    • addedOutput schema / properties / payloadJson
      Added value: +{
      +  "description": "payloadJson",
      +  "type": "string"
      +}
    • addedOutput schema / properties / product
      Added value: +{
      +  "description": "product",
      +  "type": "string"
      +}
    • addedOutput schema / properties / progressStatus
      Added value: +{
      +  "description": "progressStatus",
      +  "type": "string"
      +}
    • addedOutput schema / properties / requestId
      Added value: +{
      +  "description": "requestId",
      +  "type": "string"
      +}
    • addedOutput schema / properties / requestType
      Added value: +{
      +  "description": "requestType",
      +  "type": "string"
      +}
    • removedOutput schema / properties / result
      Removed value: -{
      -  "$ref": "#/$defs/privateRequest"
      -}
    • addedOutput schema / properties / reviewedAt
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "ISO-8601 timestamp",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / safetyStatus
      Added value: +{
      +  "description": "safetyStatus",
      +  "type": "string"
      +}
    • addedOutput schema / properties / status
      Added value: +{
      +  "description": "status",
      +  "type": "string"
      +}
    • addedOutput schema / properties / subject
      Added value: +{
      +  "description": "subject",
      +  "type": "string"
      +}
    • addedOutput schema / properties / url
      Added value: +{
      +  "description": "url",
      +  "type": "string"
      +}
    • addedOutput schema / properties / workflowStatus
      Added value: +{
      +  "description": "workflowStatus",
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "result"
      -]New value: +[
      +  "requestId",
      +  "requestType",
      +  "product",
      +  "subject",
      +  "url",
      +  "status",
      +  "payloadJson",
      +  "createdAt",
      +  "history",
      +  "safetyStatus",
      +  "workflowStatus",
      +  "jobStatus",
      +  "progressStatus",
      +  "reviewedAt"
      +]
  2. Changed1 schema field changed
    • addedInput schema / properties / webExtensionUrl
      Added value: +{
      +  "default": "",
      +  "description": "Chrome Web Store link when adding a Web Extension product. Updates use the existing product source.",
      +  "type": "string"
      +}
  3. Changed8 schema fields changed
    • addedInput schema / properties / environment / description
      Added value: +"Request environment ID from the selected get_request_options platform environments[].id. Use the returned ID verbatim."
    • addedInput schema / properties / payloadJson / description
      Added value: +"Optional request-specific settings encoded as a JSON string. Default empty. Platform and environment are supplied separately and validated by the backend."
    • addedInput schema / properties / platform / description
      Added value: +"Request platform ID from get_request_options.platforms[].id. Use the returned ID verbatim; availability may be narrower than capture platforms."
    • addedInput schema / properties / product / description
      Added value: +"Published product key for requestType=update. Leave empty for requestType=add; default empty."
    • addedInput schema / properties / requestType / description
      Added value: +"Capture request type: add for a new public HTTPS URL, or update for an existing published product."
    • addedInput schema / properties / subject / description
      Added value: +"Optional title for an add request. Default empty; the backend derives the title for updates."
    • addedInput schema / properties / url / description
      Added value: +"Public HTTPS URL to capture for requestType=add. Leave empty for update, whose source URL is derived by the backend; default empty."
    • 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": {
      +      "$ref": "#/$defs/privateRequest"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  4. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare non-read-only, non-idempotent, non-destructive; the description adds substantial context beyond that: the request is pending rather than an immediate capture, subscription/URL-safety/duplicate checks apply, scope is the authenticated user, and for updates the backend derives name and source URL. Those are exactly the behavioral facts an agent could not infer from the structured fields.

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?

Sentences are short, front-loaded, and each carries a distinct fact (mode requirements, options source, pending semantics, validation gates, submission policy). No sentence merely restates the name or the schema verbatim.

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?

For an 8-parameter mutation with an output schema and full annotation coverage, the description covers prerequisites, mode differences, and side effects well. It stops short of telling the agent how to follow up on the resulting pending request (e.g., get_product_request or wait_product_request for status), which is the one remaining gap.

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 baseline is 3, but the description adds cross-field conditional semantics that matter for correct invocation: url requires an empty product for add, product requires a published key for update, and subject is optional for add only. It does not explain payloadJson 'request-specific settings' beyond the schema, which keeps it from a 5.

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 opens with a specific verb+resource ('Submit a product capture request') and immediately splits the tool into two distinct modes, add vs update, with the required inputs for each. It is clearly distinguishable from read-oriented siblings like get_product_request or list_product_requests.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives an explicit when-to-use rule ('Call only when the user asks to submit a request') plus an explicit when-not rule ('do not automatically submit while browsing missing captures'), and routes the agent to get_request_options for platform/environment selection. That is the full when/when-not/where-to-look triad.

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