Skip to main content
Glama
Sign In
magento-api-mcp

magento-api-mcp

by florinel-chis
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_schema

Retrieve the complete definition of a Magento 2 data schema, specifying the structure of request and response data objects.

Instructions

Get the complete definition of a Magento 2 data schema/model. Schemas define the structure of request/response data objects (e.g., quote-data-cart-interface, customer-data-customer-interface).

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

Input Schema

NameRequiredDescriptionDefault
schema_nameYesThe exact schema name, e.g., 'quote-data-cart-interface'

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations provided, and the description only states a read operation without disclosing behavior on invalid input, error handling, or performance characteristics.

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?

Two sentences: one for the action and one providing context and examples. No unnecessary words, well structured.

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?

Output schema exists, so return values are covered. However, the description is minimal and could include edge cases (e.g., what happens if schema_name is invalid). Adequate but not comprehensive.

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 coverage is 100%, so baseline is 3. The description adds no extra parameter information beyond what the schema provides.

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?

Clearly states it retrieves the complete definition of a Magento 2 data schema/model. Provides examples of schema names. Does not explicitly differentiate from sibling tools like search_schemas, but the action is distinct.

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?

No guidance on when to use this tool vs alternatives. Does not mention when not to use it or prerequisites.

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