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

magento-api-mcp

by florinel-chis
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_endpoint_details

Retrieve complete documentation for any Magento 2 REST API endpoint by providing its exact path and optional HTTP method, including parameters and schemas.

Instructions

Get complete documentation for a specific Magento 2 REST API endpoint. Provide the exact path and optionally the HTTP method to get full details including parameters, request/response schemas.

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

Input Schema

NameRequiredDescriptionDefault
pathYesThe exact API path, e.g., '/V1/carts/mine'
methodNoOptional HTTP method (GET, POST, PUT, DELETE). If omitted, returns all methods for this path.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It explains the output includes parameters and schemas but does not mention authentication, rate limits, or any constraints. It is adequate but not comprehensive.

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 with no fluff: first states purpose, second provides usage instructions. Highly efficient and front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given that an output schema exists, the description need not detail return structure. It covers what input to provide and what output to expect (including parameters and schemas). Contextually complete for a documentation retrieval tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but the description adds value by clarifying the behavior when the optional 'method' is omitted: 'returns all methods for this path', which is not evident from schema alone.

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 'Get' and resource 'complete documentation for a specific Magento 2 REST API endpoint', clearly distinguishing it from siblings like search_endpoints or get_schema by requiring an exact path.

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 states to provide exact path and optionally HTTP method, implying usage for retrieving documentation for a known endpoint. However, it does not explicitly contrast with alternatives or mention when not to use it.

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