Magento API MCP

MCP开发工具

提供方 florinel-chis

开发工具 stdio · 本地进程 无需鉴权 社区 / 第三方
查看接入方式

一个本地STDIO MCP服务器,提供从OpenAPI规范中搜索和检索Magento 2 REST API文档的工具,支持离线操作和快速检索。

一句话选型结论

按资料字段整理

Magento API MCP 属于开发工具类 MCP 服务器,stdio · 本地进程,无需鉴权,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式stdio · 本地进程 鉴权无需鉴权 部署方式本地部署
GitHub 星标 7 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

适用场景

API文档Python本地部署Magento2OpenAPI离线搜索开发工具

安装与配置

stdio · 本地进程 无需鉴权
客户端在本机拉起子进程,数据不出本机
pip install -e .

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js 等运行时,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Magento API MCP当前 未标注 stdio · 本地进程 本地部署 有 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方florinel-chis上游标注的维护方 florinel-chis
分类开发工具本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

5.8 KB
来自项目仓库与上游目录的原文,未做删改

Magento 2 REST API MCP服务器

一个本地STDIO MCP服务器,提供了从OpenAPI(swagger)规范中搜索和检索Magento 2 REST API文档的工具。

特性

  • 搜索端点:在所有Magento 2 REST API端点上进行全文搜索
  • 获取端点详细信息:检索特定API终结点的完整文档
  • 列表类别:按类别标签(购物车、客户、产品等)浏览端点
  • 搜索模式:查找数据模型和模式定义
  • 获取架构详细信息:查看包含所有属性的完整架构/模型定义
  • 离线操作:使用本地swagger.json文件完全脱机工作
  • 快速启动:只有在swagger.json被修改后才重新解析

工作原理

  1. 解析:启动时,服务器解析OpenAPI 3.0 swagger.json文件
  2. 索引:提取端点、参数、响应和模式
  3. 存储:使用FTS5索引将数据存储在本地SQLite数据库中
  4. 搜索:提供跨路径、描述、参数和架构的全文搜索

安装

需求

  • Python 3.10或更高版本
  • uv(推荐)或pip

从源代码安装```bash

cd magento-api-mcp
pip install -e .


## 用法

### 运行服务器```bash
magento-api-mcp

服务器会立即启动,并在第一次运行或文件被修改时解析swagger.json文件。

配置

  • 数据库位置:默认值为 ~/.mcp/magento-api/database.db
  • 覆盖 MAGENTO_API_DB_PATH 环境变量
  • Swagger文件:默认值为 data/swagger.json 在包目录中
  • 覆盖 MAGENTO_API_SWAGGER_PATH 环境变量

与MCP客户端一起使用

配置您的MCP客户端以运行 magento-api-mcp 命令:```json
{
"mcpServers": {
"magento-api": {
"command": "magento-api-mcp"
}
}
}


或者使用自定义swagger文件:```json
{
"mcpServers": {
"magento-api": {
"command": "magento-api-mcp",
"env": {
"MAGENTO_API_SWAGGER_PATH": "/path/to/your/swagger.json"
}
}
}
}

MCP工具

1. search_endpoints

使用关键字搜索API端点。

参数:

  • queries:1-3个简短关键字查询列表(例如,[“购物车”、“客户”])
  • filter_by_method:可选HTTP方法筛选器(GET、POST、PUT、DELETE)
  • filter_by_tag:可选类别过滤器(例如“购物车/矿山”)

例子:```python
search_endpoints(queries=["cart operations"], filter_by_method="GET")


### 2. `get_endpoint_details`

获取特定端点的完整文档。

**参数:**

- `path`:准确的API路径(例如“/V1/推车/矿”)
- `method`:可选HTTP方法(如果省略,则返回此路径的所有方法)

**例子:**```python
get_endpoint_details(path="/V1/carts/mine", method="GET")

退货:

  • HTTP方法和路径
  • 类别和操作ID
  • 摘要和说明
  • 带类型和说明的参数表
  • 请求正文架构(如适用)
  • 响应代码和模式

3. list_tags

列出所有可用的API类别标记。

退货: 带有计数的所有端点类别的分层列表。

4. search_schemas

按关键字搜索数据模式/模型。

参数:

  • query:要搜索的关键字

例子:```python
search_schemas(query="customer")


### 5. `get_schema`

获取模式/模型的完整定义。

**参数:**

- `schema_name`:精确的模式名称(例如,“报价数据购物车界面”)

**退货:** 具有JSON格式的类型、描述和所有属性的完整模式。

## 验证脚本

独立测试每个组件:```bash
# Test the OpenAPI parser
python3 tests/verify_parser.py

# Test database ingestion
python3 tests/verify_db.py

# Test MCP server and all tools
python3 tests/verify_server.py

数据库模式

服务器使用SQLite和下表:

  • 端点:具有FTS5索引的所有API端点
  • 参数:端点参数
  • 回复:响应定义
  • 模式:带有FTS5索引的数据模型定义
  • 元数据:摄入追踪

相对于网络剪贴的优势

  1. 无网络依赖性:完全离线工作
  2. 即时启动:约2-5秒vs网络抓取分钟
  3. 结构化数据:访问完整的OpenAPI元数据
  4. 精确搜索:按方法、类别、响应代码筛选
  5. 模式解析:浏览复杂的嵌套数据结构
  6. 确定性的:没有HTML解析或网站结构更改

查询示例

查询 工具 目的
["cart"] search_endpoints 查找所有与购物车相关的端点
["customer", "authentication"] search_endpoints 查找客户身份验证端点
/V1/carts/mine get_endpoint_details 获取完整的购物车端点文档
customer search_schemas 查找与客户相关的架构
quote-data-cart-interface get_schema 查看购物车数据结构

发展

项目结构```

magento-api-mcp/
├── magento_api_mcp/
│ ├── init.py
│ ├── config.py # Configuration
│ ├── parser.py # OpenAPI parser
│ ├── ingest.py # Database ingestion
│ └── server.py # MCP server with tools
├── tests/
│ ├── verify_parser.py # Parser verification
│ ├── verify_db.py # Database verification
│ └── verify_server.py # Server verification
├── data/
│ └── swagger.json # OpenAPI specification
├── pyproject.toml
└── README.md


### 添加新工具

要添加新的MCP工具,请编辑 `magento_api_mcp/server.py` 并使用 `@mcp.tool()` 装饰师。

### 使用不同的Swagger文件

服务器可以使用任何OpenAPI 3.0 swaggle文件。只需设置 `MAGENTO_API_SWAGGER_PATH` 环境变量:```bash
export MAGENTO_API_SWAGGER_PATH=/path/to/different-api-swagger.json
magento-api-mcp

许可证

麻省理工学院

贡献

欢迎投稿!请在提交之前使用验证脚本测试所有更改。

支持

有关问题或疑问,请查看:

  1. 运行验证脚本以诊断问题
  2. 检查数据库位置和权限
  3. 验证swagger.json是有效的OpenAPI 3.0格式

常见问题

7 问
答案由本站依据条目字段整理,不引用上游原文
Magento API MCP 怎么安装?

在客户端按下面的安装命令接入:pip install -e .。装完在客户端配置里引用同一个包或端点。

Magento API MCP 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

Magento API MCP 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Magento API MCP 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

Magento API MCP 能提供哪些能力?

资料显示能力标签包括 API文档、开发工具、Python、API集成。具体工具清单以官方文档为准。

Magento API MCP 需要什么运行环境?

属于本地进程,需要在本机装好运行环境。

Magento API MCP 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。