Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_products_get_placement

Read-onlyIdempotent

Retrieve a product placement by product ID and placement ID to view its details, with sandbox or production selection.

Instructions

[Merchant] Get a placement.

Endpoint: GET /products/{productId}/placements/{placementId}

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": {
      "productId": "<productId>",
      "placementId": "<placementId>"
    },
    "name": "payware_products_get_placement"
  }
}

Input Schema

NameRequiredDescriptionDefault
productIdYesThe product's ID: pr + 8 letters or digits, e.g. pr7e4rCToG
useSandboxNoUse the sandbox (the default) rather than production
placementIdYesThe placement's ID: pl + 8 letters or digits, e.g. pl7e4rCToG

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description adds only the [Merchant] scope tag and the resource hierarchy implied by the endpoint path — modest context beyond the annotations, with nothing about response shape or error behavior.

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?

Two short, front-loaded lines with zero filler, and the resource being fetched leads. It borders on under-specification rather than verbosity, but as a structure/pacing matter it is clean.

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

Completeness3/5

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

For a simple idempotent read with full schema coverage and rich annotations, this is close to adequate. However, with no output schema, the description never indicates what a placement contains or what the response looks like, leaving a genuine gap for an agent deciding whether this call answers its question.

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 productId, placementId, and useSandbox are already documented in the schema with patterns and an example. The endpoint line merely restates which parameters are path segments; it adds no format or behavioral nuance beyond the schema.

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?

The description gives a specific verb and resource ("Get a placement") plus the REST path GET /products/{productId}/placements/{placementId}, which makes clear it fetches a single placement scoped to a product. It does not distinguish itself from nearby siblings such as get_placement_image or get_placement_stats, which a reader must infer from the name alone.

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

Usage Guidelines2/5

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

There is no statement of when to use this tool, no prerequisites, and no mention of alternatives for related reads. Only the implicit meaning of "Get" and the endpoint hint at retrieval; nothing is made explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools