项目简介
PrestaShop MCP 服务器是一款专为 PrestaShop 开发者设计的 Model Context Protocol (MCP) 服务器。它将庞大的 PrestaShop 官方开发开发文档(包括钩子、模块开发指南、组件架构、API 文档等)索引到本地 SQLite 数据库中,并通过 MCP 协议向兼容的 AI 助手(如 Claude、Cursor、VS Code 等)提供快速、离线、结构化的访问能力。这意味着 AI 助手可以直接调用服务器提供的工具来搜索、查询、获取 PrestaShop 的文档细节,大幅提高开发效率。
主要功能点
- 离线优先的文档访问: 无需网络连接,本地极速查询 PrestaShop 文档。
- 全面覆盖的知识库: 包含 1,095+ 份文档,涵盖 647+ PrestaShop 钩子、模块开发、组件架构、主题开发、API 文档、安装部署指南等。
- AI 助手集成: 直接与 Claude Desktop、Claude Code、VS Code、Cursor 等 MCP 兼容的 AI 工具集成。
- 高效搜索与查询: 支持基于 SQLite FTS5 的全文本搜索,可按文档类型和类别筛选。
- 丰富的数据类型: 提供专门工具访问钩子详情、文档内容、系统统计等。
- 多种传输协议: 支持 STDIO (本地)、HTTP 或 SSE (远程部署) 等多种通信方式。
- 可定制性: 允许添加您自己的项目专属 PrestaShop 文档进行索引。
安装步骤
方法一:使用 Docker (推荐) 这是最简单快捷的方式,尤其适合桌面应用如 Claude Desktop。
- 克隆仓库:
git clone https://github.com/florinel-chis/prestashop-mcp.git cd prestashop-mcp - 运行 Docker 脚本:
这个脚本会自动构建 Docker 镜像、拉取 PrestaShop 官方文档并启动服务器。chmod +x run-docker-mcp.sh ./run-docker-mcp.sh
方法二:使用 pip (推荐给 Python 用户)
- 安装:
pip install git+https://github.com/florinel-chis/prestashop-mcp.git - 手动设置 PrestaShop 官方文档:
PrestaShop MCP 服务器需要访问 PrestaShop 官方文档 仓库进行索引。请将官方文档仓库克隆到 'prestashop-mcp' 仓库的同级目录,或者设置环境变量 'PRESTASHOP_DOCS_PATH' 指向其路径。
例如(克隆到同级目录):
# 假设您在 /path/to/your/projects/ 目录下 cd /path/to/your/projects/ git clone https://github.com/florinel-chis/prestashop-mcp.git git clone https://github.com/PrestaShop/docs.git prestashop-docs - 首次运行将自动索引文档(约 30-60 秒)。
服务器配置 (用于 MCP 客户端):
将以下配置信息添加到您的 MCP 客户端的配置文件中(例如 Claude Desktop 的 'claude_desktop_config.json' 或 VS Code 项目根目录的 '.mcp.json')。
场景一:使用 Docker 脚本 (本地 STDIO 传输) 这是最常见且推荐的配置方式,尤其适合桌面 AI 应用。
{ "mcpServers": { "prestashop": { "command": "/绝对路径/到/prestashop-mcp/run-docker-mcp.sh" // 示例: "command": "/Users/youruser/projects/prestashop-mcp/run-docker-mcp.sh" // 请将 "/绝对路径/到/prestashop-mcp/" 替换为您实际克隆 prestashop-mcp 仓库的路径。 // "type": "stdio" 是默认值,可省略。 } } }
场景二:使用本地 Python 安装 (本地 STDIO 传输) 如果您通过 pip 或从源码安装,并希望直接运行 Python 模块。
{ "mcpServers": { "prestashop": { "command": "python", "args": ["-m", "prestashop_mcp.server"] // "type": "stdio" 是默认值,可省略。 } } }
场景三:使用 Docker Compose (HTTP 传输 - 适用于远程部署或特定需求) 如果您使用 'docker compose up -d' 启动服务器,它将通过 HTTP 暴露服务。
{ "mcpServers": { "prestashop": { "type": "http", "url": "http://localhost:8765/mcp" // 确保 Docker compose 启动的服务器监听在 8765 端口。 } } }
基本使用方法:
配置完成后,您的 AI 助手即可访问 PrestaShop 的专业文档。以下是一些示例查询,您可以尝试向 AI 助手提问:
- 安装与设置:
- "如何在 Mac 上本地安装 PrestaShop?"
- "PrestaShop 的系统要求是什么?"
- "展示 Docker 安装指南"
- 模块开发:
- "如何创建 PrestaShop 模块?"
- "搜索模块开发教程"
- "PrestaShop 的模块结构是什么?"
- 钩子 (Hooks):
- "展示 'displayHeader' 钩子的文档"
- "查找所有与产品相关的钩子"
- "列出所有 display 类型的钩子"
- 组件与架构:
- "PrestaShop 中有哪些 UI 组件?"
- "展示表单类型文档"
- API:
- "如何使用 PrestaShop Admin API?"
- "展示 webservice 文档"
- 通用查询:
- "显示 PrestaShop 文档统计信息"
- "列出所有可用的指南"
- "搜索部署文档"
信息
分类
开发者工具