Skip to main content
Glama
Sign In
Payware MCP Server

Payware MCP Server

Official
by payware
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

payware_campaigns_create_campaign

Create a merchant campaign with a name and optional start/end dates, then attach placements using its campaignId. Runs in sandbox by default.

Instructions

[Merchant] Create a campaign. Attach placements to it by giving its campaignId when you create or replace a placement.

Endpoint: POST /campaigns (PRM plan)

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

Input Schema

NameRequiredDescriptionDefault
nameYesCampaign name, up to 100 characters
endsOnNoLast day, YYYY-MM-DD
statusNoDescriptive only: it does not switch the placements on or off
startsOnNoFirst day, YYYY-MM-DD
useSandboxNoUse the sandbox (the default) rather than production
externalRefNoAn agency's own campaign code, up to 100 characters

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 declare that this is a non-read-only, non-idempotent, open-world, non-destructive mutation. The description adds the endpoint and the placement-linking behavior, but it does not clarify what is returned, how duplicates are handled, or what permissions are required. Since there is no output schema, the return value of campaignId is only indirectly implied.

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 description is two short sentences plus an endpoint line, with the main action front-loaded. Every element earns its place by conveying purpose, placement linkage, and plan context. There is no redundant or filler 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 moderately simple create tool with full schema descriptions and annotations covering its safety profile, the description provides the endpoint, plan context, and placement relationship. It is largely complete, though it could explicitly mention the created campaignId as a return value or note authentication expectations. These are minor gaps rather than blockers.

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 the input schema already documents all six parameters, including the status caveat and sandbox default. The description only adds the downstream relationship between campaignId and placements, not additional meaning for any input parameter. Baseline 3 is appropriate when the schema does the heavy lifting.

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: 'Create a campaign.' It also adds merchant scope and the endpoint, making the operation clear. It does not explicitly distinguish itself from siblings such as update_campaign or list_campaigns, so it falls short of a 5.

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?

The description explains how to attach placements by using the campaignId when creating or replacing a placement, and notes the PRM plan context. However, it does not state when to use this instead of update_campaign or list_campaigns, nor does it mention prerequisites beyond the plan tag. Usage is implied rather than explicitly guided.

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