magento-api-mcp

Overview Schema Source Related Servers Discussions Admin

search_endpoints

Search for Magento 2 REST API endpoints using keywords. Optionally filter by HTTP method or category tag to refine results.

Instructions

Search for Magento 2 REST API endpoints using keywords. Use SHORT keyword queries (1-3 words) to find endpoints by path, method, category, or description. You can optionally filter by HTTP method or category tag.

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

Input Schema

Name	Required	Description
`queries`	Yes	List of 1-3 short keyword queries. Examples: ['cart', 'customer'], ['product catalog'], ['order invoice']
`filter_by_method`	No	Optional: Filter by HTTP method (GET, POST, PUT, DELETE, PATCH)
`filter_by_tag`	No	Optional: Filter by category tag (e.g., 'carts/mine', 'customers', 'products')

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0May 28, 2026

TDQS

B3.3/5.0

Behavior2/5

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

No annotations are provided, and the description only outlines basic search behavior and optional filters. It lacks disclosure of pagination, return format, or error handling, which are important for an agent.

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 concise with two sentences, front-loading the purpose in the first sentence and adding usage guidance in the second. No unnecessary words.

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?

With an output schema present, the description does not need to explain return values. It covers purpose and basic usage, but fails to differentiate from sibling tools like search_schemas, leaving some context gaps.

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?

Input schema has 100% description coverage, so baseline is 3. The description adds minimal value by specifying '1-3 words' for queries and reminding of optional filters, but does not significantly enhance understanding.

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 clearly states it searches for Magento 2 REST API endpoints using keywords, which is specific and action-oriented. However, it does not explicitly differentiate from sibling tools like get_endpoint_details or search_schemas.

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?

Provides guidance to use short keyword queries (1-3 words) and optional filters by method or tag. Does not mention when to use this tool versus siblings or 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