PrestaShop MCP Server
Provides offline access to comprehensive PrestaShop development documentation including 647+ hooks, module and theme development guides, component architecture, APIs, and tutorials through full-text search and retrieval tools.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@PrestaShop MCP Server show me how to create a custom module with hooks"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
PrestaShop MCP Server
๐ Fast, local, offline-first MCP server for PrestaShop documentation with 1,095+ indexed documents including hooks, guides, components, and APIs.
A specialized Model Context Protocol (MCP) server that provides instant access to comprehensive PrestaShop development documentation for AI assistants like Claude, Cursor, and other MCP-compatible tools.
๐ฏ Why This MCP Server?
PrestaShop is a comprehensive e-commerce platform with 647+ hooks, complex component architecture, and extensive APIs. This MCP server provides instant, offline access to 1,095+ indexed documents:
647+ PrestaShop Hooks - All display and action hooks with complete metadata
Module Development - Complete guides for creating and testing modules
Component Architecture - Forms, Grids, Services, CQRS patterns (119 components)
Theme Development - Template system, Smarty/Twig documentation
API Documentation - Admin API, webservice, and domain references (96 APIs)
Guides & Tutorials - Installation, deployment, contribution guides
vs. Official PrestaShop Documentation
Feature | Official Docs Website | This (PrestaShop MCP) |
Access | Online only | Local + Offline |
Speed | Network-dependent | Instant (<50ms) |
Search | Web search | SQLite FTS5 full-text |
AI Integration | Manual lookup | Direct MCP integration |
Customization | Fixed | Add your own docs |
Related MCP server: DevDocs MCP Server
โจ Features
๐ Lightning Fast - Local SQLite FTS5 search (<50ms response time)
๐ Comprehensive Coverage - 1,095+ documents: hooks, guides, components, APIs
๐ Offline First - No network requests, works anywhere
๐ณ Docker Ready - Easy deployment with intelligent wrapper script
๐จ IDE Integration - Works with Claude Desktop, Claude Code, VS Code, Cursor
๐ง Customizable - Add your own project-specific PrestaShop docs
๐ Rich Documentation - Full syntax, parameters, examples, and metadata
๐ Smart Search - Full-text search with type, category, and origin filtering
๐ Multiple Transports - STDIO (local), HTTP, or SSE (remote deployment)
๐ฆ Installation
Option 1: Using Docker (Easiest - Recommended)
git clone https://github.com/florinel-chis/prestashop-mcp.git
cd prestashop-mcp
# Using the wrapper script (best for Claude Desktop/Code)
chmod +x run-docker-mcp.sh
./run-docker-mcp.sh
# Or using Docker Compose (for HTTP/remote deployment)
docker compose up -dThe wrapper script automatically:
Builds the Docker image if missing
Handles documentation mounting or auto-fetching
Configures STDIO transport for MCP clients
No TTY issues!
See DOCKER_USAGE.md for complete Docker setup guide.
Option 2: Using pip (Recommended for Python)
pip install git+https://github.com/florinel-chis/prestashop-mcp.gitOption 3: From Source
git clone https://github.com/florinel-chis/prestashop-mcp.git
cd prestashop-mcp
pip install -e .๐ Documentation Setup
The MCP server requires access to the PrestaShop official documentation repository for indexing.
Docker Setup (Automatic)
Docker automatically handles documentation:
On first run, it clones the PrestaShop docs repository
Documentation is baked into the Docker image during build
No manual setup needed!
Local Python Setup (Manual)
For local installations, clone the documentation repository:
# Clone PrestaShop docs as a sibling directory to prestashop-mcp
cd /path/to/your/projects/
git clone https://github.com/PrestaShop/docs.git prestashop-docs
# Directory structure should look like:
# /path/to/your/projects/
# โโโ prestashop-mcp/ (this repository)
# โโโ prestashop-docs/ (PrestaShop official docs)
# The MCP server will automatically find itOr set a custom location:
# Set environment variable
export PRESTASHOP_DOCS_PATH=/path/to/prestashop-docs
# Then run the server
prestashop-mcpDocumentation Path Priority
The server looks for documentation in this order:
Environment variable:
PRESTASHOP_DOCS_PATH(if set)Sibling directory:
../prestashop-docs(relative to MCP server)Inside project:
./prestashop-docs(for Docker builds)
First Run Indexing
On first run, the server will:
Locate the PrestaShop documentation repository
Parse and index 1,095+ markdown files
Extract metadata (hooks, components, APIs, guides)
Build SQLite FTS5 search index with Porter stemming
Store in
~/.mcp/prestashop-docs/database.db
Indexing takes ~30-60 seconds on first run, then uses the cached database for instant startup.
Force reindexing:
# Local installation
python -m prestashop_mcp.ingest_v2 --force
# Or delete the database
rm ~/.mcp/prestashop-docs/database.db๐ฎ Usage
With Claude Desktop
Standard Installation:
Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"prestashop": {
"command": "prestashop-mcp"
}
}
}Docker Installation (using wrapper script):
{
"mcpServers": {
"prestashop": {
"command": "/absolute/path/to/prestashop-mcp/run-docker-mcp.sh"
}
}
}Docker Installation (HTTP transport):
{
"prestashop": {
"type": "http",
"url": "http://localhost:8765/mcp"
}
}(Requires running docker compose up -d first)
With VS Code
Create .mcp.json in your project root:
{
"mcpServers": {
"prestashop": {
"type": "stdio",
"command": "prestashop-mcp"
}
}
}With Claude Code
Create .mcp.json in your project root:
{
"mcpServers": {
"prestashop": {
"command": "/absolute/path/to/run-docker-mcp.sh"
}
}
}Or for local Python installation:
{
"mcpServers": {
"prestashop": {
"command": "python",
"args": ["-m", "prestashop_mcp.server"]
}
}
}With Cursor
Add to Cursor's MCP configuration (Settings > Features > MCP Servers):
{
"mcpServers": {
"prestashop": {
"command": "prestashop-mcp"
}
}
}๐ ๏ธ Available MCP Tools
Once configured, your AI assistant has access to 7 specialized tools:
Documentation Tools
1. search_prestashop_docs(query, doc_type, category)
Search ALL PrestaShop documentation using full-text search.
Parameters:
query- Search termsdoc_type- Filter by: hook, guide, tutorial, api, component, etc.category- Filter by: basics, development, modules, themes, etc.
Example:
"Search PrestaShop docs for module development"
"Find installation guides for Mac"2. get_prestashop_doc(path)
Get the full content of a specific documentation file.
Example:
"Get the Mac installation guide"3. list_prestashop_docs(doc_type, category)
List available documentation files with optional filters.
Example:
"List all PrestaShop guides"
"Show me all tutorial documents"4. get_prestashop_stats()
Get statistics about the indexed documentation.
Example:
"Show me PrestaShop documentation statistics"Hook Tools
5. search_prestashop_hooks(queries, hook_type, origin)
Search PrestaShop hooks specifically.
Example:
"Find all hooks related to products"6. get_prestashop_hook(hook_name)
Get complete documentation for a specific hook.
Example:
"Show me the displayHeader hook"7. list_prestashop_hooks(hook_type, origin)
List all hooks organized by type and origin.
Example:
"List all display hooks"๐ฌ Example Queries
Try asking your AI assistant:
Installation & Setup:
"How do I install PrestaShop locally on Mac?"
"What are the system requirements for PrestaShop?"
"Show me the Docker installation guide"
Module Development:
"How do I create a PrestaShop module?"
"Search for module development tutorials"
"What's the module structure in PrestaShop?"
Theme Development:
"How do I develop a PrestaShop theme?"
"Show me Twig template documentation"
"Find theme development guides"
Hooks:
"Show me documentation for the displayHeader hook"
"Find all hooks related to products"
"List all display hooks"
"How does the actionProductAdd hook work?"
Components & Architecture:
"What UI components are available in PrestaShop?"
"Show me form types documentation"
"Explain the CQRS pattern in PrestaShop"
APIs:
"How do I use the PrestaShop Admin API?"
"Show me webservice documentation"
"Find API endpoint references"
General:
"Show me PrestaShop documentation statistics"
"List all available guides"
"Search for deployment documentation"
๐ Documentation Coverage
Total: 1,095+ Indexed Documents
By Document Type
647 Hooks - All PrestaShop hooks with metadata
Display hooks (render content)
Action hooks (trigger functionality)
Core, Module, and Theme hooks
Back office and Front office locations
138 General Docs - Guides, tutorials, contribution docs
119 Components - Forms, Grids, Services, UI components
96 API References - Admin API, webservice, domain references
64 References - Technical references and specifications
12 Guides - Installation, deployment, development guides
10 FAQs - Frequently asked questions
9 Tutorials - Step-by-step tutorials
By Category
697 Module docs - Module development and hooks
208 Development docs - Components, architecture, patterns
88 Webservice docs - API and webservice references
29 Theme docs - Theme development and templates
22 Contribution docs - Contributing to PrestaShop
17 Basics - Installation, system requirements, deployment
And more...
Specialized Data
386 Domain References - CQRS commands and queries
119 UI Components - Form types, grid columns, etc.
๐ง Development
Running Tests
# Run all tests
pytest
# Run specific test
pytest tests/test_ingest.py
# Run with coverage
pytest --cov=prestashop_mcpManual Testing
# Index documentation (uses new comprehensive indexer)
python -m prestashop_mcp.ingest_v2
# Force reindex
python -m prestashop_mcp.ingest_v2 --force
# Check database
sqlite3 ~/.mcp/prestashop-docs/database.db "SELECT COUNT(*) FROM prestashop_docs;"
# Get statistics by type
sqlite3 ~/.mcp/prestashop-docs/database.db "SELECT doc_type, COUNT(*) FROM prestashop_docs GROUP BY doc_type;"๐ How It Works
Indexing: On first run, indexes 1,095+ documentation files into SQLite with FTS5
Hooks, guides, tutorials, API docs, components, and more
Automatic categorization and metadata extraction
CQRS domain references and UI component detection
Storage: Documentation stored in
~/.mcp/prestashop-docs/database.dbSearch: Uses SQLite FTS5 for efficient full-text search with ranking
Porter stemming for better search results
Filter by document type, category, and other metadata
Retrieval: Direct lookups by path or name for instant access
Multi-Transport: Supports STDIO (local), HTTP, and SSE (remote) protocols
๐ค Contributing
Contributions welcome! Please read our Contributing Guide.
Quick Start
# Fork and clone
git clone https://github.com/florinel-chis/prestashop-mcp.git
cd prestashop-mcp
# Create virtual environment
python -m venv venv
source venv/bin/activate # or `venv\Scripts\activate` on Windows
# Install for development
pip install -e ".[dev]"
# Run tests
pytest
# Format code
black prestashop_mcp/
# Make changes and submit PR๐ License
MIT License - see LICENSE file for details.
๐ Acknowledgments
Inspired by Shopify Liquid MCP
Docker integration based on best practices from Magento GraphQL Docs MCP, thank you @cmuench
Built with FastMCP
Documentation from PrestaShop Docs
MCP Protocol by Anthropic
๐ Related Projects
Shopify Liquid MCP - For Shopify theme development
Magento GraphQL Docs MCP - For Magento development
FastMCP - MCP server framework
Model Context Protocol - MCP specification
๐ Support
๐ Issues
๐ฌ Discussions
Made with โค๏ธ for the PrestaShop development community
Available Tools
7 toolsget_prestashop_docA
Get the full content of a specific PrestaShop documentation file.
Args: path: Document path (e.g., 'basics/installation/environments/macos-specific.md')
Returns: Full document content with metadata
Inputs: path (required). Returns: result
get_prestashop_hookA
Get complete documentation for a specific PrestaShop hook.
Args: hook_name: Name of the hook (e.g., 'displayHeader', 'actionProductAdd')
Returns: Complete hook documentation including description, parameters, examples
Inputs: hook_name (required). Returns: result
get_prestashop_statsB
Get statistics about indexed PrestaShop documentation.
Returns: Statistics about documents, types, categories, and specialized data
Inputs: no named parameters. Returns: result
list_prestashop_docsB
List PrestaShop documentation files.
Args: doc_type: Filter by type: hook, guide, tutorial, api, reference, component, faq, general category: Filter by category: basics, development, modules, themes, etc.
Returns: List of available documents
Inputs: doc_type, category. Returns: result
list_prestashop_hooksB
List all available PrestaShop hooks.
Args: hook_type: Filter by type (display, action) origin: Filter by origin (core, module, theme)
Returns: List of all hooks organized by type and origin
Inputs: hook_type, origin. Returns: result
search_prestashop_docsA
Search ALL PrestaShop documentation (guides, tutorials, API docs, hooks, etc.).
Args: query: Search query (e.g., "install", "Mac", "deployment") doc_type: Filter by type: hook, guide, tutorial, api, reference, component, faq, general category: Filter by category: basics, development, modules, themes, etc.
Returns: Search results with snippets and metadata
Inputs: query (required), doc_type, category. Returns: result
search_prestashop_hooksB
Search PrestaShop hooks using full-text search.
Args: queries: List of search terms (maximum 3) hook_type: Filter by hook type (display, action) origin: Filter by origin (core, module, theme)
Returns: Formatted search results with hook details
Inputs: queries (required), hook_type, origin. Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelogโฆ
TDQS
Scored across 7 tools
Every tool has a clearly distinct purpose with no overlap: get_doc vs. list_docs vs. search_docs, and similarly for hooks, plus separate stats tool. The descriptions reinforce distinct actions (get, list, search) on different resources (docs, hooks, stats), making misselection unlikely.
All tools follow a consistent verb_noun pattern with 'prestashop' prefix: get_prestashop_doc, list_prestashop_docs, search_prestashop_docs, etc. The naming is predictable and readable throughout, with no deviations in style or convention.
Seven tools is well-scoped for a documentation server, covering core operations (get, list, search) for both docs and hooks, plus a stats tool. Each tool earns its place without feeling thin or bloated, fitting typical MCP server ranges.
The tool surface provides complete coverage for accessing PrestaShop documentation: CRUD-like operations (get, list, search) for both docs and hooks, plus metadata via stats. There are no obvious gaps or dead ends for an agent working with this domain.
Maintenance
Related MCP Connectors
Provide your AI coding tools with token-efficient access to up-to-date technical documentation forโฆ
@latest documentation and code examples to 9000+ libraries for LLMs and AI code editors in a singlโฆ
Versioned documentation registry and semantic search for AI tools and coding assistants.
Docsy gives AI assistants current, version-specific documentation for libraries, frameworks and SDKs. Resolve library IDs and versions, then search and fetch focused official documentation with original source links using five read-only MCP tools. Hosted Streamable HTTP with OAuth 2.1 sign-in.
Related MCP Servers
- AlicenseAqualityDmaintenanceProvides instant, offline access to complete Shopify Liquid documentation (198 docs covering tags, filters, and objects) for AI assistants to help with theme development and Liquid templating.73MIT
- FlicenseAqualityDmaintenanceProvides AI models with direct access to documentation for over 600 technologies from DevDocs.io, including popular languages, frameworks, and tools. It enables comprehensive searching, content retrieval, and offline access via an intelligent local caching system.122-
- AlicenseNot gradedqualityBmaintenanceProvides a specialized environment for developing InstantCMS 2 addons and templates by exposing hooks, class APIs, and code structures to AI assistants. It enables automated scaffolding, validation, and searching of system components to streamline the creation of functional CMS extensions.17 npm12MIT
- AlicenseAqualityBmaintenanceEnables coding agents to list, search, and read a curated Shopware developer and merchant knowledge base offline as plain Markdown files, without network access or an API key.491 npmMIT