@socialai/website-mcp 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,228 @@
+# @socialai/website-mcp
+
+> MCP server for **Social AI Website Builder** — let Claude, Codex, Cursor, VS Code Copilot and any MCP-compatible AI tool create and manage your websites by calling the Social AI API directly.
+
+[![npm version](https://img.shields.io/npm/v/@socialai/website-mcp)](https://www.npmjs.com/package/@socialai/website-mcp)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+---
+
+## What it does
+
+Connect your AI coding tool to Social AI and let it:
+
+- **Create full websites from templates** — "Build me a streetwear store"
+- **Generate and fill page content** — "Write the About page for my coffee brand"
+- **Manage products** — bulk import via CSV, add variants, update stock
+- **Configure payments by country** — auto-selects the right provider (Paystack for ZA, Stripe for US/UK, etc.)
+- **Upload images** — host product photos from URLs or local files
+- **Set contact details, newsletter, language** — all from within the AI chat
+- **Publish live** — one tool call and the site goes live on your subdomain
+
+---
+
+## Quick start
+
+### 1. Get an API key
+
+Sign up at [socialai.one](https://socialai.one) → **Settings → API Keys** → Generate key.
+
+### 2. Add to your AI tool
+
+**Claude Code** (`~/.claude/settings.json`):
+```json
+{
+  "mcpServers": {
+    "socialai-websites": {
+      "command": "npx",
+      "args": ["-y", "@socialai/website-mcp"],
+      "env": {
+        "SOCIALAI_API_KEY": "your_api_key_here",
+        "SOCIALAI_API_URL": "https://socialai.one"
+      }
+    }
+  }
+}
+```
+
+**Claude Desktop** (File → Settings → Developer → Edit Config):
+```json
+{
+  "mcpServers": {
+    "socialai-websites": {
+      "command": "npx",
+      "args": ["-y", "@socialai/website-mcp"],
+      "env": {
+        "SOCIALAI_API_KEY": "your_api_key_here",
+        "SOCIALAI_API_URL": "https://socialai.one"
+      }
+    }
+  }
+}
+```
+
+**Cursor** (`.cursor/mcp.json`):
+```json
+{
+  "mcpServers": {
+    "socialai-websites": {
+      "command": "npx",
+      "args": ["-y", "@socialai/website-mcp"],
+      "env": {
+        "SOCIALAI_API_KEY": "your_api_key_here"
+      }
+    }
+  }
+}
+```
+
+**VS Code / GitHub Copilot** (`.vscode/settings.json`):
+```json
+{
+  "mcp": {
+    "servers": {
+      "socialai-websites": {
+        "type": "stdio",
+        "command": "npx",
+        "args": ["-y", "@socialai/website-mcp"],
+        "env": {
+          "SOCIALAI_API_KEY": "your_api_key_here"
+        }
+      }
+    }
+  }
+}
+```
+
+**Windsurf / Codeium**: Same JSON structure as Claude Desktop, added to Windsurf's MCP settings.
+
+**OpenAI Codex** (`~/.codex/config.json`):
+```json
+{
+  "mcpServers": {
+    "socialai-websites": {
+      "command": "npx",
+      "args": ["-y", "@socialai/website-mcp"],
+      "env": {
+        "SOCIALAI_API_KEY": "your_api_key_here"
+      }
+    }
+  }
+}
+```
+
+### 3. Restart your AI tool — then try it
+
+```
+"Create a coffee shop website using the best matching template, 
+ set the country to South Africa, add 5 products and publish it."
+```
+
+---
+
+## Available tools
+
+### Sites
+| Tool | Description |
+|------|-------------|
+| `list_templates` | Browse all built-in shop & website templates |
+| `create_website_from_template` | Fork a template into a new project (seeds demo products) |
+| `create_website` | Create a blank website or shop |
+| `list_websites` | List all your website projects |
+| `get_website` | Get project details + pages |
+| `update_website` | Update name, subdomain, SEO |
+| `set_domain` | Set subdomain or custom domain |
+| `publish_website` | Push draft live at `*.socialai.one` |
+| `delete_website` | Permanently delete a project |
+
+### Pages & Content
+| Tool | Description |
+|------|-------------|
+| `list_pages` | List all pages |
+| `get_page` | Get a page with its full block content |
+| `create_page` | Add a page (About, T&C, Contact…) |
+| `update_page_blocks` | Replace all blocks on a page |
+| `delete_page` | Delete a page |
+| `generate_content` | AI-generate blocks, copy or a full page layout |
+| `get_theme` | Read colour/font theme |
+| `apply_theme` | Update colours and fonts |
+
+### Store / Shop
+| Tool | Description |
+|------|-------------|
+| `list_products` | List products |
+| `add_product` | Add a product |
+| `update_product` | Edit price, stock, images, status |
+| `delete_product` | Delete a product |
+| `list_variants` | List size/colour/SKU variants |
+| `add_variants` | Add variants to a product |
+| `clear_variants` | Remove all variants |
+| `list_categories` | List product categories |
+| `export_products_csv` | Export catalogue as CSV |
+| `import_products_csv` | Bulk-import/update up to 500 products from CSV |
+| `get_payment_settings` | Read payment provider + country-specific recommendations |
+| `configure_payments` | Set provider, country, currency (auto-fills currency from country) |
+
+### Site Settings
+| Tool | Description |
+|------|-------------|
+| `get_site_settings` | Read contact email, language, newsletter config |
+| `configure_site_settings` | Set contact email, phone, language, newsletter provider |
+
+### Media
+| Tool | Description |
+|------|-------------|
+| `upload_image` | Host an image from a URL |
+| `upload_image_file` | Upload a base64-encoded local image |
+
+### Reporting
+| Tool | Description |
+|------|-------------|
+| `report_issue` | Report a bug or unexpected behaviour to the Social AI team |
+
+---
+
+## Country-aware payments
+
+Setting the country auto-fills currency and returns the recommended payment providers for that market:
+
+```
+"Set up this site for the United States"
+→ configure_payments({ country: "US" })
+→ Returns: currency=USD, recommendedProviders=["stripe","paypal","square"]
+
+"Set up this site for South Africa"  
+→ configure_payments({ country: "ZA" })
+→ Returns: currency=ZAR, recommendedProviders=["paystack","payfast","ozow"]
+```
+
+Supported countries: ZA, NG, KE, GH, EG, US, CA, BR, MX, GB, DE, FR, AU, AE, IN + more.
+
+---
+
+## Environment variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `SOCIALAI_API_KEY` | ✅ | Your Social AI API key (from Settings → API Keys) |
+| `SOCIALAI_API_URL` | Optional | API base URL. Default: `https://socialai.one` |
+
+---
+
+## Local development
+
+```bash
+git clone https://github.com/Buyup1/SocialAI2
+cd SocialAI2/mcp
+npm install
+npm run build
+
+# Test against your local dev server
+SOCIALAI_API_KEY=your_key SOCIALAI_API_URL=http://localhost:3000 node test-local.mjs
+```
+
+---
+
+## License
+
+MIT © Social AI

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@socialai/website-mcp",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "MCP server for Social AI Website Builder — create and manage websites via Claude Code, OpenAI Codex, and any MCP-compatible AI tool",
   "type": "module",
   "bin": {
     "socialai-mcp": "dist/index.js"
   },
   "main": "dist/index.js",
-  "files": ["dist"],
+  "files": ["dist", "README.md"],
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",