Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_campaigns_get_campaign

Read-onlyIdempotent

Retrieve a campaign's details and placement IDs by campaign ID, so merchants can inspect campaign placements before managing or reporting on them.

Instructions

[Merchant] Get a campaign, with the IDs of its placements you can see.

Endpoint: GET /campaigns/{campaignId}

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": {
      "campaignId": "<campaignId>"
    },
    "name": "payware_campaigns_get_campaign"
  }
}

Input Schema

NameRequiredDescriptionDefault
campaignIdYesThe campaign's ID: cp + 8 letters or digits, e.g. cp7e4rCToG
useSandboxNoUse the sandbox (the default) rather than production

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.0

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already establish that this is a read-only, idempotent, non-destructive operation, so the description does not need to repeat safety basics. It adds useful behavioral context that the response includes visible placement IDs and names the HTTP endpoint, but it omits return shape, error behavior, and sandbox implications beyond what the schema states.

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?

The definition is extremely concise and front-loads the merchant-facing action before the endpoint. Every element contributes useful information, with no redundant or meandering wording.

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 a simple read-by-ID tool with full schema coverage and rich annotations, the description provides enough context about what is retrieved and the visibility of placement IDs. The main omission is that no output schema exists, yet the description does not outline the campaign response beyond placement IDs, though this is a minor gap for such a straightforward lookup.

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%, and the schema fully documents campaignId format and the useSandbox default. The description only echoes the campaignId placeholder in the endpoint path and adds no meaning beyond the schema for either parameter.

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 states a specific verb and resource: get a campaign, plus a notable scope detail that it includes IDs of placements visible to the caller. It does not explicitly distinguish itself from siblings such as get_campaign_stats or list_campaigns, so it is clear but not fully differentiated.

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

Usage Guidelines3/5

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

Usage is implied by the single-campaign GET endpoint and required campaignId, making it reasonably clear that this retrieves one campaign by ID. However, it gives no explicit when-to-use guidance versus list_campaigns, get_campaign_stats, or update_campaign, and no exclusion conditions.

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