Shopify Liquid MCP Server

# ✅ Documentation Included This repository includes **all 198 Shopify Liquid documentation files** in the `docs-source/` directory. ## What's Included ``` docs-source/ ├── tags/ 30 Liquid tags ├── filters/ 101 Liquid filters ├── objects/ 67 Liquid objects ├── INDEX.md Complete documentation index ├── README.md Documentation guide └── *.md Overview and basics files Total: 211 markdown files (~900 KB) ``` ## Why Documentation is Included 1. **Offline-First** - No network required after installation 2. **Fast** - Instant access, no API calls 3. **Reliable** - Works anywhere, anytime 4. **Customizable** - Add your own docs 5. **Complete** - All 198 Shopify Liquid docs ## How It Works ### Automatic Indexing When you first run the MCP server: ```bash shopify-liquid-mcp ``` The server automatically: 1. Finds docs in `docs-source/` 2. Indexes them into SQLite with FTS5 3. Creates database at `~/.mcp/shopify-liquid-docs/database.db` 4. Ready for instant search! ### Manual Reindexing Force reindex anytime: ```bash python -m shopify_liquid_mcp.ingest --force ``` ### Custom Documentation Add your own Liquid snippets: 1. Create `docs-source/custom/my-snippet.md` 2. Follow the Markdown format 3. Reindex: `python -m shopify_liquid_mcp.ingest --force` 4. Your docs are now searchable! ## Path Resolution The server looks for docs in this order: 1. **Package path**: `shopify_liquid_mcp/../docs-source/` (when installed) 2. **Development path**: `../shopify-liquid-docs/` (for development) 3. **Environment variable**: `SHOPIFY_LIQUID_DOCS_PATH` (custom location) This ensures docs work in: - ✅ pip installations - ✅ Docker containers - ✅ Development setup - ✅ Custom deployments ## Docker In Docker, docs are copied during build: ```dockerfile # Documentation is included in image COPY docs-source/ ./docs-source/ # Indexed on first run RUN python -m shopify_liquid_mcp.ingest ``` ## Package Distribution When installed via pip, docs are included: ```toml [tool.hatch.build] include = [ "shopify_liquid_mcp/**/*.py", "docs-source/**/*.md", # ← Docs included! ] ``` ## Updates To update Shopify Liquid docs: 1. Download latest from https://shopify.dev/docs/api/liquid 2. Replace files in `docs-source/` 3. Reindex 4. Commit and push ## vs. Official Shopify MCP | Feature | Official MCP | This MCP | |---------|-------------|----------| | Docs Storage | Remote (queries shopify.dev) | **Local (included)** | | Offline | ❌ Needs internet | **✅ Fully offline** | | Speed | Network-dependent | **<1ms (instant)** | | Custom Docs | ❌ Not supported | **✅ Add your own** | ## Benefits ### For Users - No network requests (except initial install) - Works on planes, trains, offline - Consistent fast performance - Add project-specific docs ### For Developers - Easy to fork and customize - Add company-specific Liquid patterns - Share team knowledge - Version control your docs ## File Size The `docs-source/` directory adds ~900 KB to the package: - **Small enough** for npm/pip packages - **Large enough** for complete documentation - **Compressed** in distribution (even smaller) ## Verification Check docs are included: ```bash # List docs find docs-source -name "*.md" | wc -l # Should show: 211 # Check size du -sh docs-source # Should show: ~900K # Test indexing python -m shopify_liquid_mcp.ingest # Should show: "Successfully indexed 202 documents" ``` ## License - **Documentation content**: From Shopify (see their terms) - **MCP server code**: MIT License - **This package**: MIT License (code only, docs are Shopify's) --- **All documentation is included and ready to use!** 🎉 No additional downloads needed after installation.