diff --git a/README.md b/README.md index a0ddeb3..a17d9ab 100644 --- a/README.md +++ b/README.md @@ -8,28 +8,38 @@ ## 💡 What This Unlocks -**This MCP server gives AI direct access to your entire Squarespace workspace.** Instead of clicking through interfaces, you just *tell* it what you need. +**This MCP server gives AI direct access to your Squarespace Commerce and website platform.** Instead of manually managing products, orders, pages, and inventory through the Squarespace interface, you just *tell* the AI what you need — in plain English. -### 🎯 Squarespace-Native Power Moves +### 🎯 E-Commerce & Website Power Moves -The AI can directly control your Squarespace account with natural language: +The AI can directly control your Squarespace site with natural language: -- **Smart automation** — Complex workflows in plain English -- **Data intelligence** — Query, analyze, and export your Squarespace data -- **Rapid operations** — Bulk actions that would take hours manually -- **Cross-platform integration** — Combine Squarespace with other tools seamlessly +1. **Inventory Sync** — "Check inventory levels across all products and flag any with less than 5 units remaining" +2. **Order Processing** — "Show me all pending orders from the last week and their fulfillment status" +3. **Product Catalog** — "List all digital products and their current prices" +4. **Content Management** — "Get all published pages and show me their last modified dates" +5. **Stock Updates** — "Update inventory for product variant XYZ to 100 units and set it to unlimited stock" ### 🔗 The Real Power: Combining Tools -AI can chain multiple Squarespace operations together: +AI can chain multiple Squarespace operations together in one conversation: -- Query data → Filter results → Generate reports -- Search records → Update fields → Notify team -- Analyze metrics → Create tasks → Schedule follow-ups +- Query low-stock products → Generate restock list → Update inventory levels +- Pull order data → Match customer info → Export fulfillment queue +- Analyze page content → Cross-reference products → Generate marketing content +- List all orders → Filter by status → Create fulfillment workflow ## 📦 What's Inside -**61 API tools** covering the entire Squarespace platform (E-commerce). +**8 powerful API tools** covering Squarespace Commerce and website management: +- `list_pages` — Browse website pages with pagination +- `get_page` — Get specific page details and content +- `list_products` — Query product catalog with filters +- `get_product` — Get complete product details +- `list_orders` — Browse orders with status filters +- `get_order` — Get full order details +- `list_inventory` — Check stock levels for all variants +- `update_inventory` — Adjust product inventory levels All with proper error handling, automatic authentication, and TypeScript types. @@ -45,7 +55,11 @@ All with proper error handling, automatic authentication, and TypeScript types. npm run build ``` -2. **Get your Squarespace API credentials** (see Authentication section below) +2. **Get your Squarespace API key:** + - Log in to your Squarespace account + - Go to **Settings → Advanced → API Keys** + - Click **Generate Key** (requires Commerce Advanced plan or Developer mode) + - Copy your API key securely 3. **Configure Claude Desktop:** @@ -58,7 +72,7 @@ All with proper error handling, automatic authentication, and TypeScript types. "mcpServers": { "squarespace": { "command": "node", - "args": ["/ABSOLUTE/PATH/TO/squarespace-mcp/dist/index.js"], + "args": ["/ABSOLUTE/PATH/TO/squarespace-mcp-2026-complete/dist/index.js"], "env": { "SQUARESPACE_API_KEY": "your-api-key-here" } @@ -74,7 +88,7 @@ All with proper error handling, automatic authentication, and TypeScript types. [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/squarespace-mcp) 1. Click the button above -2. Set your Squarespace API credentials in Railway dashboard +2. Set your Squarespace API key in Railway dashboard 3. Use the Railway URL as your MCP server endpoint ### Option 3: Docker @@ -88,26 +102,60 @@ docker run -p 3000:3000 \ ## 🔐 Authentication -See the official [Squarespace API documentation](https://docs.squarespace.com) for authentication details. +**Squarespace uses Bearer Token (OAuth2) authentication with API Keys.** -The MCP server handles token refresh automatically. +**Setup Steps:** +1. In Squarespace admin: **Settings → Advanced → API Keys** +2. Click **Generate Key** (requires Commerce Advanced or Developer plan) +3. Select scopes: + - **Website Content**: Read (for pages) + - **Commerce**: Read & Write (for products, orders, inventory) +4. Copy and save your API key securely (shown only once!) + +**API Documentation:** https://developers.squarespace.com/commerce-apis + +**Note:** API access requires: +- **Commerce Advanced plan** or higher +- **Developer mode** enabled (for some features) + +The MCP server handles all API requests automatically using your API key. ## 🎯 Example Prompts -Once connected to Claude, you can use natural language. Examples: +Once connected to Claude, you can use natural language for e-commerce and website operations: -- *"Show me recent activity in Squarespace"* -- *"Create a new record with these details..."* -- *"Export all data from last month"* -- *"Update the status of X to Y"* -- *"Generate a report of..."* +**Inventory Management:** +- *"Show me all products with inventory below 10 units"* +- *"Update inventory for variant ID abc123 to 75 units"* +- *"List all products with unlimited inventory enabled"* + +**Order Management:** +- *"Get all orders from the last 7 days"* +- *"Show me pending orders that need fulfillment"* +- *"Get complete details for order #12345 including line items"* + +**Product Catalog:** +- *"List all physical products currently in the catalog"* +- *"Show me digital products with prices over $50"* +- *"Get product details for item SKU 'SUMMER-2024'"* + +**Website Content:** +- *"List all published pages on the site"* +- *"Get the content and metadata for the 'About' page"* +- *"Show me pages modified in the last month"* + +**Combined Operations:** +- *"Generate a report of all low-stock items and their current inventory"* +- *"List orders from this week and show which products are most popular"* +- *"Check all product variants and identify which need inventory updates"* ## 🛠️ Development ### Prerequisites - Node.js 18+ - npm or yarn -- Squarespace account with API access +- Squarespace site with Commerce Advanced or Developer plan +- API key with appropriate scopes ### Setup @@ -116,7 +164,7 @@ git clone https://github.com/BusyBee3333/Squarespace-MCP-2026-Complete.git cd squarespace-mcp-2026-complete npm install cp .env.example .env -# Edit .env with your Squarespace credentials +# Edit .env with your Squarespace API key npm run build npm start ``` @@ -132,18 +180,24 @@ npm run test:coverage # Coverage report ## 🐛 Troubleshooting ### "Authentication failed" -- Verify your API credentials are correct -- Check that your API key hasn't been revoked -- Ensure you have the necessary permissions +- Verify your API key is correct (check for copy/paste errors) +- Ensure your API key hasn't expired or been revoked +- Confirm you have the **Commerce Advanced plan** or Developer mode enabled ### "Tools not appearing in Claude" - Restart Claude Desktop after updating config -- Check that the path in `claude_desktop_config.json` is absolute +- Check that the path in `claude_desktop_config.json` is **absolute** (not relative) - Verify the build completed successfully (`dist/index.js` exists) +### "403 Forbidden" errors +- Check that your API key has the required scopes enabled +- Some endpoints require specific plan levels (Commerce Advanced+) +- Verify you're not hitting rate limits + ## 📖 Resources -- [Squarespace API Documentation](https://docs.squarespace.com) +- [Squarespace Commerce API Documentation](https://developers.squarespace.com/commerce-apis) +- [Squarespace API Reference](https://developers.squarespace.com/commerce-apis/reference) - [MCP Protocol Specification](https://modelcontextprotocol.io/) - [Claude Desktop Documentation](https://claude.ai/desktop) @@ -163,7 +217,7 @@ MIT License - see [LICENSE](LICENSE) for details ## 🙏 Credits -Built by [MCPEngine](https://mcpengage.com) — AI infrastructure for business software. +Built by [MCPEngage](https://mcpengage.com) — AI infrastructure for business software. Want more MCP servers? Check out our [full catalog](https://mcpengage.com) covering 30+ business platforms. diff --git a/package.json b/package.json index 982220a..1006058 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "MCP server for Squarespace API - 2026 Complete Version", "type": "module", "main": "dist/index.js", - "author": "MCPEngine ", + "author": "MCPEngage ", "license": "MIT", "repository": { "type": "git",