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.

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
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +}
  2. 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"
      +}
  3. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare non-readOnly, non-idempotent, non-destructive, so the mutation profile is known; the description adds real context beyond that — it is asynchronous (pending, not immediate) and gated by subscription, URL safety and duplicate checks. The duplicate-check note is valuable against idempotentHint=false. It stops short of naming the follow-up tool (wait_product_request) or the returned request identifier, leaving a small gap.

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?

Roughly six short sentences, front-loaded with the core action, then mode requirements, prerequisite tool, and guardrail. Every sentence carries either a constraint or a routing rule; nothing is redundant with the title or annotations.

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, non-idempotent mutation with an output schema and annotations, the description covers mode conditionals, prerequisites, asynchronous semantics and validation gates. The only material omission is what the agent should do after submission (polling via wait_product_request or get_product_request), which the "pending request" phrasing only implies.

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 baseline is 3, but the description adds cross-parameter constraints the schema documents only per-field: add needs a public HTTPS url plus an empty product, update needs an existing published product key with the source URL derived by the backend, and subject is optional. It also flags that payloadJson is backend-validated rather than free-form.

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 ("Submit a product capture request") and immediately splits the two modes (add vs update) with their distinct inputs. An agent can distinguish this from read-side siblings like get_product_request or list_product_requests 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 Guidelines5/5

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

Explicit conditional routing: "Call only when the user asks to submit a request; do not automatically submit while browsing missing captures" gives a clear when-not rule, and "Select platform/environment from get_request_options" names the prerequisite sibling. It also declares "Creates a pending request, not an immediate capture," which sets expectations against synchronous tools.

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