Prestashop MCP

🚀 PrestaShop MCP Server

🚀 高速でローカル、オフライン対応のMCPサーバーで、PrestaShopのドキュメントを提供します。1,095以上の索引付きドキュメントがあり、フック、ガイド、コンポーネント、APIなどが含まれています。

これは、Model Context Protocol (MCP)に特化したサーバーで、ClaudeやCursorなどのAIアシスタントや他のMCP互換ツールに、PrestaShopの開発ドキュメントを即座に提供します。

🚀 クイックスタート

このPrestaShop MCPサーバーは、PrestaShopの開発に関する包括的なドキュメントをAIアシスタントに提供するための専用サーバーです。以下のセクションで、このサーバーの特徴、インストール方法、使用方法などを説明します。

✨ 主な機能

• 🚀 超高速 - ローカルのSQLite FTS5検索を使用して、レスポンス時間が50ms未満です。
• 📚 包括的なカバレッジ - 1,095以上のドキュメントを提供します。フック、ガイド、コンポーネント、APIなどが含まれています。
• 🔌 オフライン対応 - ネットワーク要求が不要で、どこでも動作します。
• 🐳 Docker対応 - インテリジェントなラッパースクリプトを使用して、簡単にデプロイできます。
• 🎨 IDE統合 - Claude Desktop、Claude Code、VS Code、Cursorなどと統合できます。
• 🔧 カスタマイズ可能 - 独自のPrestaShopドキュメントを追加できます。
• 📖 豊富なドキュメント - 完全な構文、パラメーター、例、メタデータを提供します。
• 🔍 スマート検索 - タイプ、カテゴリ、オリジンでフィルタリングできる全文検索を提供します。
• 🌐 複数のトランスポート - STDIO（ローカル）、HTTP、またはSSE（リモートデプロイ）をサポートします。

📦 インストール

オプション1: Dockerを使用する（最も簡単 - おすすめ）

git clone https://github.com/florinel-chis/prestashop-mcp.git
cd prestashop-mcp

# ラッパースクリプトを使用する（Claude Desktop/Codeに最適）
chmod +x run-docker-mcp.sh
./run-docker-mcp.sh

# またはDocker Composeを使用する（HTTP/リモートデプロイ用）
docker compose up -d

ラッパースクリプトは自動的に以下のことを行います。

• Dockerイメージがない場合はビルドします。
• ドキュメントのマウントまたは自動取得を処理します。
• MCPクライアント用にSTDIOトランスポートを構成します。
• TTYの問題はありません！

完全なDockerセットアップガイドについては、DOCKER_USAGE.mdを参照してください。

オプション2: pipを使用する（Pythonにおすすめ）

pip install git+https://github.com/florinel-chis/prestashop-mcp.git

オプション3: ソースからインストール

git clone https://github.com/florinel-chis/prestashop-mcp.git
cd prestashop-mcp
pip install -e .

📚 ドキュメントのセットアップ

MCPサーバーは、索引付けのためにPrestaShop公式ドキュメントリポジトリにアクセスする必要があります。

Dockerセットアップ（自動）

Dockerは自動的にドキュメントを処理します。

• 初回実行時に、PrestaShopドキュメントリポジトリをクローンします。
• ドキュメントはビルド時にDockerイメージに組み込まれます。
• 手動でのセットアップは不要です！

ローカルPythonセットアップ（手動）

ローカルインストールの場合は、ドキュメントリポジトリをクローンします。

# PrestaShopドキュメントをprestashop-mcpの兄弟ディレクトリとしてクローンする
cd /path/to/your/projects/
git clone https://github.com/PrestaShop/docs.git prestashop-docs

# ディレクトリ構造は以下のようになります。
# /path/to/your/projects/
#   ├── prestashop-mcp/     (このリポジトリ)
#   └── prestashop-docs/    (PrestaShop公式ドキュメント)

# MCPサーバーは自動的に検出します

または、カスタム場所を設定します。

# 環境変数を設定する
export PRESTASHOP_DOCS_PATH=/path/to/prestashop-docs

# サーバーを実行する
prestashop-mcp

ドキュメントパスの優先順位

サーバーは以下の順序でドキュメントを探します。

1. 環境変数: PRESTASHOP_DOCS_PATH（設定されている場合）
2. 兄弟ディレクトリ: ../prestashop-docs（MCPサーバーに対する相対パス）
3. プロジェクト内: ./prestashop-docs（Dockerビルド用）

初回実行時の索引付け

初回実行時に、サーバーは以下のことを行います。

1. PrestaShopドキュメントリポジトリを見つけます。
2. 1,095以上のMarkdownファイルを解析して索引付けます。
3. メタデータ（フック、コンポーネント、API、ガイド）を抽出します。
4. Porterステミングを使用してSQLite FTS5検索インデックスを構築します。
5. ~/.mcp/prestashop-docs/database.dbに保存します。

索引付けには初回実行時に約30 - 60秒かかり、その後はキャッシュされたデータベースを使用して即座に起動します。 強制的に再索引付けするには、以下のコマンドを実行します。

# ローカルインストール
python -m prestashop_mcp.ingest_v2 --force

# またはデータベースを削除する
rm ~/.mcp/prestashop-docs/database.db

💻 使用例

Claude Desktopでの使用

標準インストール macOSの場合は~/Library/Application Support/Claude/claude_desktop_config.json、Windowsの場合は%APPDATA%\Claude\claude_desktop_config.jsonを編集します。

{
  "mcpServers": {
    "prestashop": {
      "command": "prestashop-mcp"
    }
  }
}

Dockerインストール（ラッパースクリプトを使用）

{
  "mcpServers": {
    "prestashop": {
      "command": "/absolute/path/to/prestashop-mcp/run-docker-mcp.sh"
    }
  }
}

Dockerインストール（HTTPトランスポート）

{
  "prestashop": {
    "type": "http",
    "url": "http://localhost:8765/mcp"
  }
}

（最初にdocker compose up -dを実行する必要があります）

VS Codeでの使用

プロジェクトルートに.mcp.jsonを作成します。

{
  "mcpServers": {
    "prestashop": {
      "type": "stdio",
      "command": "prestashop-mcp"
    }
  }
}

Claude Codeでの使用

プロジェクトルートに.mcp.jsonを作成します。

{
  "mcpServers": {
    "prestashop": {
      "command": "/absolute/path/to/run-docker-mcp.sh"
    }
  }
}

または、ローカルPythonインストールの場合は、以下のようにします。

{
  "mcpServers": {
    "prestashop": {
      "command": "python",
      "args": ["-m", "prestashop_mcp.server"]
    }
  }
}

Cursorでの使用

CursorのMCP設定（Settings > Features > MCP Servers）に追加します。

{
  "mcpServers": {
    "prestashop": {
      "command": "prestashop-mcp"
    }
  }
}

🛠️ 利用可能なMCPツール

設定後、AIアシスタントは7つの専用ツールにアクセスできます。

ドキュメントツール

1. search_prestashop_docs(query, doc_type, category)

全文検索を使用して、すべてのPrestaShopドキュメントを検索します。 パラメーター

• query - 検索用語
• doc_type - フィルター: hook、guide、tutorial、api、componentなど
• category - フィルター: basics、development、modules、themesなど 例

"Search PrestaShop docs for module development"
"Find installation guides for Mac"

2. get_prestashop_doc(path)

特定のドキュメントファイルの完全な内容を取得します。 例

"Get the Mac installation guide"

3. list_prestashop_docs(doc_type, category)

オプションのフィルターで利用可能なドキュメントファイルをリストします。 例

"List all PrestaShop guides"
"Show me all tutorial documents"

4. get_prestashop_stats()

索引付けされたドキュメントの統計情報を取得します。 例

"Show me PrestaShop documentation statistics"

フックツール

5. search_prestashop_hooks(queries, hook_type, origin)

PrestaShopのフックを具体的に検索します。 例

"Find all hooks related to products"

6. get_prestashop_hook(hook_name)

特定のフックの完全なドキュメントを取得します。 例

"Show me the displayHeader hook"

7. list_prestashop_hooks(hook_type, origin)

タイプとオリジンで整理されたすべてのフックをリストします。 例

"List all display hooks"

💬 例のクエリ

AIアシスタントに以下の質問を試してみてください。

インストールとセットアップ

• "How do I install PrestaShop locally on Mac?"
• "What are the system requirements for PrestaShop?"
• "Show me the Docker installation guide"

モジュール開発

• "How do I create a PrestaShop module?"
• "Search for module development tutorials"
• "What's the module structure in PrestaShop?"

テーマ開発

• "How do I develop a PrestaShop theme?"
• "Show me Twig template documentation"
• "Find theme development guides"

フック

• "Show me documentation for the displayHeader hook"
• "Find all hooks related to products"
• "List all display hooks"
• "How does the actionProductAdd hook work?"

コンポーネントとアーキテクチャ

• "What UI components are available in PrestaShop?"
• "Show me form types documentation"
• "Explain the CQRS pattern in PrestaShop"

API

• "How do I use the PrestaShop Admin API?"
• "Show me webservice documentation"
• "Find API endpoint references"

一般

• "Show me PrestaShop documentation statistics"
• "List all available guides"
• "Search for deployment documentation"

📊 ドキュメントのカバレッジ

合計: 1,095以上の索引付きドキュメント

ドキュメントタイプ別

• 647個のフック - すべてのPrestaShopフックとメタデータ
  • 表示フック（コンテンツをレンダリング）
  • アクションフック（機能をトリガー）
  • コア、モジュール、テーマのフック
  • バックオフィスとフロントオフィスの場所
• 138個の一般ドキュメント - ガイド、チュートリアル、貢献ドキュメント
• 119個のコンポーネント - フォーム、グリッド、サービス、UIコンポーネント
• 96個のAPIリファレンス - 管理API、ウェブサービス、ドメインリファレンス
• 64個のリファレンス - 技術的なリファレンスと仕様
• 12個のガイド - インストール、デプロイ、開発ガイド
• 10個のFAQ - よくある質問
• 9個のチュートリアル - ステップバイステップのチュートリアル

カテゴリ別

• 697個のモジュールドキュメント - モジュール開発とフック
• 208個の開発ドキュメント - コンポーネント、アーキテクチャ、パターン
• 88個のウェブサービスドキュメント - APIとウェブサービスのリファレンス
• 29個のテーマドキュメント - テーマ開発とテンプレート
• 22個の貢献ドキュメント - PrestaShopへの貢献
• 17個の基本ドキュメント - インストール、システム要件、デプロイ
• その他...

特殊データ

• 386個のドメインリファレンス - CQRSコマンドとクエリ
• 119個のUIコンポーネント - フォームタイプ、グリッド列など

🔧 開発

テストの実行

# すべてのテストを実行
pytest

# 特定のテストを実行
pytest tests/test_ingest.py

# カバレッジを含めて実行
pytest --cov=prestashop_mcp

手動テスト

# ドキュメントを索引付けする（新しい包括的なインデクサーを使用）
python -m prestashop_mcp.ingest_v2

# 強制的に再索引付けする
python -m prestashop_mcp.ingest_v2 --force

# データベースを確認する
sqlite3 ~/.mcp/prestashop-docs/database.db "SELECT COUNT(*) FROM prestashop_docs;"

# タイプ別の統計情報を取得する
sqlite3 ~/.mcp/prestashop-docs/database.db "SELECT doc_type, COUNT(*) FROM prestashop_docs GROUP BY doc_type;"

📖 動作原理

1. 索引付け - 初回実行時に、1,095以上のドキュメントファイルをSQLiteにFTS5で索引付けします。
   • フック、ガイド、チュートリアル、APIドキュメント、コンポーネントなど
   • 自動的なカテゴリ分けとメタデータ抽出
   • CQRSドメインリファレンスとUIコンポーネントの検出
2. 保存 - ドキュメントは~/.mcp/prestashop-docs/database.dbに保存されます。
3. 検索 - SQLite FTS5を使用して、ランキング付きの効率的な全文検索を行います。
   • Porterステミングを使用して、より良い検索結果を得ます。
   • ドキュメントタイプ、カテゴリ、その他のメタデータでフィルタリングできます。
4. 取得 - パスまたは名前で直接検索して、即座にアクセスできます。
5. マルチトランスポート - STDIO（ローカル）、HTTP、およびSSE（リモート）プロトコルをサポートします。

🤝 貢献

貢献を歓迎します！Contributing Guideを読んでから、以下の手順で貢献してください。

# フォークしてクローンする
git clone https://github.com/florinel-chis/prestashop-mcp.git
cd prestashop-mcp

# 仮想環境を作成する
python -m venv venv
source venv/bin/activate  # Windowsの場合は `venv\Scripts\activate`

# 開発用にインストールする
pip install -e ".[dev]"

# テストを実行する
pytest

# コードを整形する
black prestashop_mcp/

# 変更を加えてPRを提出する

📜 ライセンス

MITライセンス - 詳細はLICENSEファイルを参照してください。

🙏 謝辞

• Shopify Liquid MCPに触発されました。
• Docker統合は、Magento GraphQL Docs MCPのベストプラクティスに基づいています。@cmuenchに感謝します。
• FastMCPを使用して構築されています。
• ドキュメントはPrestaShop Docsから取得しています。
• MCPプロトコルはAnthropicによるものです。

🔗 関連プロジェクト

• Shopify Liquid MCP - Shopifyテーマ開発用
• Magento GraphQL Docs MCP - Magento開発用
• FastMCP - MCPサーバーフレームワーク
• Model Context Protocol - MCP仕様

📞 サポート

• 🐛 Issues
• 💬 Discussions

PrestaShop開発コミュニティのために❤️ で作られました