shopware-mcp

Entity schema

entity_schema

Read-onlyIdempotent

Inspect a Shopware entity's fields and associations from the shop schema, or list all entity names, to build precise filters for searches and field selection.

Instructions

Describe a Shopware entity: its fields (name, type, flags such as required/translatable) and associations (name, relation, target entity), taken from the shop's own entity schema. Call it without entity to list all entity names. Use it to build precise filters for entity_search or the fields parameter of other tools. Returns one object.

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": "entity_schema"
  }
}

Input Schema

Name	Required	Description	Default
`entity`	No	Entity name; omit to list all entities

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.11.1Nov 6, 2026

TDQS

A4.1/5.0

Behavior4/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, and destructiveHint=false, so safety is covered. The description adds useful behavioral context beyond that: it states the data comes from the shop's own entity schema and that the return value is one object. It does not discuss error behavior for unknown entities, but that is a minor gap given the annotation coverage.

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?

The description is four short sentences and is front-loaded with the core purpose before moving to usage and return shape. The 'Call it without `entity`' guidance duplicates the schema's parameter description slightly, but it earns its place as usage guidance rather than schema repetition.

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?

With one optional parameter, no output schema, and no nested objects, the description covers what the tool returns and when to use it. It could say more about how associations are represented or what happens with an unknown entity, but the definition is complete enough for correct invocation.

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% for the single optional `entity` parameter, and the schema already states 'omit to list all entities.' The description repeats that behavior rather than adding syntax, naming rules, or format details beyond the schema, so baseline 3 is appropriate.

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?

The description uses a specific verb and resource: it describes a Shopware entity, including fields with name/type/flags and associations with name/relation/target. This is clearly distinct from siblings like entity_search, which it references as a downstream consumer, so an agent can identify the tool's role 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 Guidelines4/5

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

It gives clear usage guidance: call it without `entity` to list all entity names, and use it to build precise filters for entity_search or the `fields` parameter of other tools. It stops short of explicit when-not-to-use guidance or naming a directly competing alternative, which keeps it from a 5.

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