MCP server for searching Magento 2 REST API documentation
Wellknown found it in public sources; nobody has proven control of it yet. Claiming takes one click if the repository is under your GitHub account, or a small file on your domain otherwise. Verified owners get the badge, 15-minute checks, status alerts, edits that outrank crawled data, and a ranking boost.
Agents can do it too: POST https://wellknown.network/api/v1/claims with {"agent":"iflow-mcp-florinel-chis-magento-api-mcp","method":"well_known_file"} — machine-readable steps at claim.json, guide at /docs/claim.
Everything here was measured by our prober or read from a registry. Nothing is self-reported.
Attributed to the source that supplied each field. Treated as claims, not facts.
# Magento 2 REST API MCP Server A local STDIO MCP server that provides tools to search and retrieve Magento 2 REST API documentation from OpenAPI (swagger) specifications. ## Features - **Search Endpoints**: Full-text search across all Magento 2 REST API endpoints - **Get Endpoint Details**: Retrieve complete documentation for specific API endpoints - **List Categories**: Browse endpoints by category tags (carts, customers, products, etc.) - **Search Schemas**: Find data models and schema definitions - **Get Schema Details**: View complete schema/model definitions with all properties - **Offline Operation**: Works entirely offline using local swagger.json file - **Fast Startup**: Only re-parses if swagger.json has been modified ## How it Works 1. **Parsing**: On startup, the server parses the OpenAPI 3.0 swagger.json file 2. **Indexing**: Extracts endpoints, parameters, responses, and schemas 3. **Storage**: Stores data in a local SQLite database with FTS5 indexes 4. **Searching**: Provides full-text search across paths, descriptions, parameters, and schemas ## Installation ### Requirements - Python 3.10 or higher - uv (recommended) or pip ### Install from Source ```bash cd magento-api-mcp pip install -e . ``` ## Usage ### Running the Server ```bash magento-api-mcp ``` The server starts immediately and parses the swagger.json file on first run or when the file has been modified. ### Configuration - **Database Location**: Default is `~/.mcp/magento-api/database.db` - Override with `MAGENTO_API_DB_PATH` environment variable - **Swagger File**: Default is `data/swagger.json` in the package directory - Override with `MAGENTO_API_SWAGGER_PATH` environment variable ### Using with an MCP Client Configure your MCP client to run the `magento-api-mcp` command: ```json { "mcpServers": { "magento-api": { "command": "magento-api-mcp" } } } ``` Or with custom swagger file: ```json { "mcpServers": { "magento-api": { "command"…
Mapped onto the structured taxonomy from declared text and observed tool names. Confidence shown for derived entries.
Every source is kept verbatim. Field changes are logged as events.