vibedsgn-mcp 1.2.1 → 1.3.0

package/README.md

@@ -21,7 +21,19 @@ Built for agents — every tool has a workflow-explaining description, structure
 npx vibedsgn-mcp init
 ```
 
-**Option B: Manual configuration**
+**Option B: Non-interactive setup (CI / non-TTY shells)**
+
+```bash
+npx vibedsgn-mcp init --key vdsgn_your_key_here --agent claude --yes
+# or via env var:
+VIBEDSGN_API_KEY=vdsgn_your_key_here npx vibedsgn-mcp init --agent cursor --yes
+```
+
+Flags: `--key` (or `VIBEDSGN_API_KEY` env), `--agent claude|cursor|manual`, `--url <custom-api>`, `--yes` (fail instead of prompting).
+
+> **After install: fully restart your AI agent.** Most MCP clients (Claude Code, Cursor) cache the config in memory at startup — `/mcp reconnect` only re-handshakes the existing process. Quit and reopen the agent for the new config to take effect.
+
+**Option C: Manual configuration**
 
 <details>
 <summary>Claude Code (~/.claude.json)</summary>
@@ -87,38 +99,59 @@ Returns: `{ count, tools: [{ id, name, slug, category, description }] }`
 
 Publish a design to Vibedsgn. Vibes go live immediately — no draft step.
 
-**Workflow:**
-1. Call `whoami` to confirm auth
-2. Call `list_design_tools` (with `q: "cursor"` or similar) to pick `primaryToolId`
-3. **(Optional)** Call `post_vibe` with `dryRun: true` to preview the predicted slug + tool name without uploading or publishing — useful for "show the user, then commit" flows
-4. Call `post_vibe` with the title, primaryToolId, and **either** `desktopImageUrl` (a public URL — preferred) **or** `desktopImage` (base64 PNG, max 4MB)
+**Minimal call:**
+
+```json
+{
+  "title": "My App",
+  "primaryTool": "claude-code",
+  "liveUrl": "https://my-app.com"
+}
+```
 
-**Required fields:**
-- `title` — Project name
-- `primaryToolId` — Tool ID from `list_design_tools`
-- `desktopImageUrl` *or* `desktopImage` — at least one
+That's it. The server auto-renders desktop + mobile screenshots of `liveUrl` (no third-party services), uploads them, and publishes. The MCP resolves `primaryTool` ("claude-code") to its id automatically.
+
+**Image input — pick ONE (or none if `liveUrl` is set):**
+
+| Field | Type | Notes |
+|-------|------|-------|
+| *(none)* | — | If you set `liveUrl`, the server screenshots it. Easiest. |
+| `imagePath` | string | Local PNG/JPG/WebP file. The MCP reads it and uploads. |
+| `desktopImageUrl` | url | Public image URL. The server fetches it and re-uploads. |
+| `desktopImage` | base64 | Last resort — slow over stdio, but works without files or URLs. |
+
+**Tool selection — pick ONE:**
+
+| Field | Type | Notes |
+|-------|------|-------|
+| `primaryTool` | string | Slug, name, or id (e.g. `"claude-code"`, `"Cursor"`). Resolved automatically — no extra `list_design_tools` call. |
+| `primaryToolId` | string | Exact id, if you already have one. |
 
 **Optional fields:**
 
 | Field | Type | Notes |
 |-------|------|-------|
 | `description` | string | 1-2 sentences |
-| `desktopImageUrl` | url | Preferred. Server fetches and uploads. |
-| `desktopImage` | base64 | Fallback. Slower because base64 doubles payload. |
-| `mobileImageUrl` / `mobileImage` | url / base64 | Optional mobile screenshot |
+| `mobileImagePath` / `mobileImageUrl` / `mobileImage` | string / url / base64 | Manual mobile screenshot. Skip if using auto-screenshot. |
 | `tags` | string[] | Free-form curation tags |
 | `systemPrompt` | string | Generation prompt used |
 | `processNotes` | string | Notes about the build process |
 | `aiStack` | object | `{ codingAgents?, imageGen?, videoGen?, other? }` — all inner arrays optional |
 | `designSystem` | object | `{ colors?, typography? }` |
-| `liveUrl` | url | Live project URL |
+| `liveUrl` | url | Live project URL — also doubles as the screenshot source |
 | `githubUrl` | url | GitHub repo URL |
-| `dryRun` | boolean | When `true`, validate inputs and return the predicted slug + tool without uploading or publishing. No DB write, no Vercel Blob call. Default `false`. |
+| `dryRun` | boolean | Validate inputs and return the predicted slug + tool without uploading or publishing. Default `false`. |
 
 Returns: `{ id, slug, url, message }` — `url` is the absolute https URL of the published vibe.
 
 When `dryRun: true`, returns: `{ dryRun: true, wouldCreate: { slug, url, title, primaryTool: { id, name, slug } }, message }` instead. No `id` because no row is created.
 
+**Notes on auto-screenshot:**
+
+- The `liveUrl` must be **publicly reachable** — `localhost`, `127.0.0.1`, and private IPs (10/8, 172.16/12, 192.168/16) are rejected. Expose your app via `ngrok` / `cloudflared` if testing locally.
+- Server-side rendering uses headless Chromium. First request can take a few seconds (cold start).
+- If you already have a screenshot, prefer `imagePath` (fastest) or `desktopImageUrl`.
+
 ### `delete_vibe`
 
 Permanently delete a vibe you own. Cascades to likes, bookmarks, comments, and notifications. **Irreversible.**