AI导哈

Shopify Liquid文档服务器

一个专为Shopify Liquid模板开发设计的本地化、离线优先的文档服务器，提供快速访问完整的Liquid标签、过滤器和对象文档。

  • by florinel-chis
  • Python
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 florinel-chis/shopify-liquid-mcp

使用说明

Shopify Liquid MCP服务器

🚀 快速、本地、离线的第一台MCP服务器 用于Shopify Liquid文档 198综合文档 包括所有标签、过滤器和对象。

一个专业 模型上下文协议（MCP） 服务器，为Claude、Cursor和其他MCP兼容工具等AI助手提供即时访问完整Shopify Liquid文档的功能。

🎯 为什么选择MCP服务器？

vs.官方Shopify MCP

Shopify提供 官方MCP服务器 涵盖所有Shopify API，此服务器专门针对 液体模板开发:

功能 Shopify官方MCP 此（流动MCP）
聚焦 所有Shopify API（管理、店面、功能等） 仅适用于液体模板
存储 远程（查询shopify.dev） 本地（无需网络）
速度 网络依赖 瞬时（<1ms）
离线 ❌ 需要互联网 ✅ 完全离线
定制 固定文档 添加您自己的文档
覆盖 API通用文件 198液体专用文件
运行时 Node.js python

用例

使用Shopify官方MCP：

  • 管理员API/GraphQL开发
  • 使用Shopify API进行应用程序开发
  • 功能和POS扩展
  • 实时模式验证

此液体MCP用于：

  • Liquid主题开发
  • 液体模板调试
  • 线下开发
  • 更快的液体参考查找
  • 项目特定的Liquid片段

两者都用！ 它们完美互补——API的官方MCP，Liquid的MCP。

✨ 特性

  • 🚀 迅速的 -本地SQLite FTS5搜索（响应时间<1ms）
  • 📚 全覆盖 -30个标签，101个过滤器，67个对象（共198个文档）
  • 🔌 离线优先 -无网络请求，可在任何地方工作
  • 🐳 Docker就绪 -一次指挥部署
  • 🎨 IDE集成 -适用于VS Code、Cursor、Claude Desktop、Zed
  • 🔧 可定制的 -添加您自己的特定于项目的Liquid文档
  • 📖 丰富的文档 -所有内容的完整语法、参数和示例
  • 🔍 智能搜索 -全文搜索，突出显示代码段

📦 安装

选项1：使用pip（推荐）

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

选项2：使用Docker

# Pull the image
docker pull florinel-chis/shopify-liquid-mcp:latest

# Or build locally
docker build -t shopify-liquid-mcp .
docker run -it shopify-liquid-mcp

选项3：使用docker compose

docker-compose up -d

选项4：来源

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

🎮 用法

使用VS代码

使用Docker

创建或编辑 .vscode/settings.json:

{
  "mcp.servers": {
    "shopify-liquid": {
      "type": "docker",
      "image": "shopify-liquid-mcp:latest",
      "transport": "stdio"
    }
  }
}

使用本地安装

创建 .mcp.json 在项目根目录中：

{
  "mcpServers": {
    "shopify-liquid": {
      "type": "stdio",
      "command": "shopify-liquid-mcp"
    }
  }
}

或添加到VS代码设置：

{
  "mcp.servers": {
    "shopify-liquid": {
      "command": "shopify-liquid-mcp",
      "args": [],
      "transport": "stdio"
    }
  }
}

使用克劳德桌面

编辑 ~/Library/Application Support/Claude/claude_desktop_config.json （macOS）或 %APPDATA%\Claude\claude_desktop_config.json （Windows）：

使用Docker

{
  "mcpServers": {
    "shopify-liquid": {
      "type": "stdio",
      "command": "docker",
      "args": ["run", "-i", "--rm", "shopify-liquid-mcp:latest"]
    }
  }
}

使用本地安装

{
  "mcpServers": {
    "shopify-liquid": {
      "command": "shopify-liquid-mcp"
    }
  }
}

带光标

添加到Cursor的MCP配置（设置>功能>MCP服务器）：

{
  "mcpServers": {
    "shopify-liquid": {
      "command": "shopify-liquid-mcp"
    }
  }
}

或者使用Docker：

{
  "mcpServers": {
    "shopify-liquid": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "shopify-liquid-mcp:latest"]
    }
  }
}

Zed编辑器

创建 .zed/settings.json:

{
  "context_servers": {
    "shopify-liquid": {
      "command": "shopify-liquid-mcp"
    }
  }
}

使用Continue.dev

编辑 ~/.continue/config.json:

{
  "mcpServers": [
    {
      "name": "shopify-liquid",
      "command": "shopify-liquid-mcp"
    }
  ]
}

🛠️ 可用工具

配置后，您的AI助手可以访问7个专用工具：

1. search_liquid_docs(queries: List[str])

在所有Shopify Liquid文档中进行全文搜索。

例子：

AI: I'll search for "for loop" in the documentation...

2. get_liquid_tag(tag_name: str)

获取特定标签的完整文档。

例子：

AI: Let me get the documentation for the 'for' tag...

3. get_liquid_filter(filter_name: str)

获取特定过滤器的完整文档。

例子：

AI: I'll look up the 'upcase' filter documentation...

4. get_liquid_object(object_name: str)

获取特定对象的完整文档。

例子：

AI: Let me check the 'product' object properties...

5. list_liquid_tags()

按类别列出所有30个可用标签。

6. list_liquid_filters()

按类别列出所有101个可用筛选器。

7. list_liquid_objects()

按类别列出所有67个可用对象。

💬 查询示例

试着问你的人工智能助手：

获取文档：

  • “显示for循环标记的文档”
  • “钱过滤器在液体中是如何工作的？”
  • “产品对象上有哪些可用属性？”

搜索：

  • “搜索有关购物车功能的文档”
  • “查找与日期相关的所有筛选器”
  • “我可以将哪些对象用于收藏？”

列表：

  • “列出所有Shopify Liquid标签”
  • “显示所有可用的字符串筛选器”
  • “有哪些迭代标签可用？”

建筑：

  • “帮助我在网格中显示产品”
  • “如何在Liquid中设置日期格式？”
  • “演示如何使用购物车”

📊 文件覆盖范围

完整参考

  • 30液体标签

    • 控制流程： if, unless, case, else
    • 迭代： for, break, continue, cycle, tablerow, paginate
    • 变量： assign, capture, increment, decrement, echo
    • 主题： layout, section, sections, render, include, content_for
    • HTML/资源： form, style, stylesheet, javascript
    • 语法： comment, raw, liquid, doc

  • 101液体过滤器

    • 字符串（24）： upcase, downcase, capitalize, append, prepend等等。
    • 数组（13）： join, sort, reverse, map, where, size等等。
    • 数学（11）： plus, minus, times, divided_by, modulo等等。
    • 金钱（4）： money, money_with_currency等等。
    • 图片（5）： image_url, image_tag等等。
    • 颜色（9）： color_darken, color_lighten等等。
    • 还有更多。..

  • 67液体物体

    • 店铺： shop, settings, theme, brand
    • 产品： product, variant, collection, collections
    • 购物车： cart, line_item, checkout
    • 客户： customer, address, company
    • 内容： page, blog, article, comment
    • 媒体： image, video, media, model
    • 还有更多。..

🐳 Docker使用

快速开始

# Build the image
docker build -t shopify-liquid-mcp .

# Run the server
docker run -it --rm shopify-liquid-mcp

# Run with persistent data
docker run -it --rm -v mcp-data:/data shopify-liquid-mcp

使用docker编写

# Start the server
docker-compose up -d

# View logs
docker-compose logs -f

# Stop the server
docker-compose down

# Shell access
docker-compose exec shopify-liquid-mcp bash

自定义文档

添加项目特定的Liquid文档：

# Create custom docs directory
mkdir custom-docs

# Add your .md files
cp my-snippets.md custom-docs/

# Mount in docker-compose.yml
volumes:
  - ./custom-docs:/docs/custom:ro

🔧 发展

运行测试

# Run all tests
pytest

# Run specific test
pytest tests/test_ingest.py

# Run with coverage
pytest --cov=shopify_liquid_mcp

手动测试

# Test the server
python test_server.py

# Test indexing
python -m shopify_liquid_mcp.ingest

# Check database
sqlite3 ~/.mcp/shopify-liquid-docs/database.db "SELECT COUNT(*) FROM liquid_docs;"

重新索引文档

# Force reindex
python -m shopify_liquid_mcp.ingest --force

# Custom database location
SHOPIFY_LIQUID_DB_PATH=/custom/path/db.sqlite python -m shopify_liquid_mcp.ingest

📖 文档

🤝 贡献

欢迎投稿！请阅读我们的 贡献指南.

快速开始

# Fork and clone
git clone https://github.com/florinel-chis/shopify-liquid-mcp.git
cd shopify-liquid-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

# Make changes and submit PR

📜 许可证

MIT许可证-请参阅 许可证 文件以获取详细信息。

🙏 致谢

🔗 相关项目

📞 支持

⭐ 星迹

由...制作❤️ Shopify主题开发社区

相关 MCP