shopware-mcp

List promotions

promotions_list

Read-onlyIdempotent

List discount campaigns with their code settings, validity window, redemption limits, and discount summaries. Filter by active status or code to review promotion details and totals.

Instructions

List promotions (discount campaigns) with code settings, validity window, redemption limits and a summary of their discounts (scope, type, value). Filter by active or code. Returns { total, page, limit, items[] }.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "promotions_list"
  }
}

Input Schema

Name	Required	Description
`page`	No	1-based page
`sort`	No	Sort order; defaults per tool
`term`	No	Full-text search term
`limit`	No	Items per page, max 50 (default from SHOPWARE_MCP_DEFAULT_LIMIT)
`fields`	No	Extra raw entity fields to add to each item, e.g. ['customFields', 'ean']. Dot-paths allowed.
`filter`	No	Criteria filters, combined with AND

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.11.1Nov 6, 2026

TDQS

A3.5/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, covering the safety profile. The description adds useful behavioral context by disclosing the response envelope ({ total, page, limit, items[] }) and the shape of each promotion summary.

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 compact sentences, front-loaded with what is listed and what the result contains. Every sentence carries content, though 'Filter by active or code' is slightly underspecified relative to the generic filter schema.

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 six-parameter list tool with no output schema, the definition covers the resource, the fields included per item, the result envelope, and a filtering hint. An agent has enough to call it correctly, with only the sibling-routing gap remaining.

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 schema documents page, limit, sort, term, fields, and the criteria filter structure in detail. The description adds only a hint about filtering by active status or code, without mapping those to concrete filter fields or operators.

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?

States a specific verb and resource ('List promotions (discount campaigns)') and enumerates the content returned: code settings, validity window, redemption limits, and discount summaries. It does not distinguish itself from siblings such as promotions_check or promotion_impact, so it stops 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 Guidelines2/5

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

'Filter by active or code' describes a capability rather than when to choose this tool over promotions_check, promotion_impact, or entity_search. There is no explicit when-to-use, when-not-to-use, or alternative routing guidance.

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