@productbrain/mcp 0.0.1-beta.3 → 0.0.1-beta.3012

package/.env.mcp.example

@@ -2,27 +2,26 @@
 # Copy this file to .env.mcp and fill in your values.
 # In Claude Desktop / Cursor, these are typically set via the MCP config's "env" block.
 
-# ── Cloud Mode (recommended) ──────────────────────────────────────────
+# ── Required ─────────────────────────────────────────────────────────
 #
 # PRODUCTBRAIN_API_KEY — Your API key from Settings → API Keys.
-#                        Starts with pb_sk_. This is the only required variable.
-#
-# PRODUCTBRAIN_URL     — Override the backend URL.
-#                        Defaults to Product Brain Cloud. Set to http://localhost:3210
-#                        for local development.
+#                        Starts with pb_sk_. Workspace, user, and scope
+#                        are all derived server-side from this key.
 
 # PRODUCTBRAIN_API_KEY=pb_sk_your_key_here
-# PRODUCTBRAIN_URL=
 
-# ── Self-Hosted Mode ──────────────────────────────────────────────────
+# ── Deployment URL (optional) ────────────────────────────────────────
+#
+# CONVEX_SITE_URL — Your Convex deployment SITE URL (*.convex.site, NOT *.convex.cloud).
+#                   Defaults to Product Brain Cloud if not set.
 #
-# CONVEX_SITE_URL  — Your Convex deployment SITE URL (*.convex.site, NOT *.convex.cloud).
-# MCP_API_KEY      — Shared secret matching the Convex dashboard env var.
-# WORKSPACE_SLUG   — The workspace slug to operate on.
+# PRODUCTBRAIN_URL — Alias for CONVEX_SITE_URL (for backward compat).
 
 # CONVEX_SITE_URL=https://your-deployment.convex.site
-# MCP_API_KEY=your-secret-api-key
-# WORKSPACE_SLUG=your-workspace-slug
+
+# PB_CONNECT_GATEWAY_URL — (CLI only) Override gateway for `pb connect` token redemption.
+#                          Takes precedence over CONVEX_SITE_URL and the production default.
+# PB_CONNECT_GATEWAY_URL=https://your-custom-gateway.example.com
 
 # ── Debug (optional) ──────────────────────────────────────────────────
 # MCP_DEBUG=1

package/README.md

@@ -0,0 +1,67 @@
+# Product Brain MCP (`@productbrain/mcp`)
+
+Give your AI agent your product's memory. Read the Chain, capture decisions, and write back — from Claude Code, Claude Desktop, Cursor, or any MCP client.
+
+**Requirements:** Node 18+, and an API key from Product Brain → Settings → API Keys (starts with `pb_sk_`).
+
+## Install
+
+Pre-GA, always pin the `beta` tag:
+
+```bash
+npx -y @productbrain/mcp@beta
+```
+
+## Connect your client
+
+### Claude Code
+
+```bash
+claude mcp add productbrain \
+  -e PRODUCTBRAIN_API_KEY=pb_sk_your_key_here \
+  -- npx -y @productbrain/mcp@beta
+```
+
+### Claude Desktop
+
+`claude_desktop_config.json`:
+
+```jsonc
+{
+  "mcpServers": {
+    "productbrain": {
+      "command": "npx",
+      "args": ["-y", "@productbrain/mcp@beta"],
+      "env": {
+        "PRODUCTBRAIN_API_KEY": "pb_sk_your_key_here"
+      }
+    }
+  }
+}
+```
+
+### Cursor
+
+`~/.cursor/mcp.json` — same `command` / `args` / `env` block as above.
+
+## Configuration
+
+| Variable | Required | Default |
+|---|---|---|
+| `PRODUCTBRAIN_API_KEY` | yes | — your `pb_sk_` key. Workspace, user, and scope are all derived server-side from the key. |
+| `CONVEX_SITE_URL` | no | Product Brain Cloud. Point at another deployment (a `*.convex.site` URL, not `*.convex.cloud`). |
+| `PRODUCTBRAIN_URL` | no | Alias for `CONVEX_SITE_URL`. |
+| `MCP_DEBUG` | no | Set to `1` for verbose logs on stderr. |
+
+See `.env.mcp.example` in this package for the annotated list.
+
+## What your agent gets
+
+Tools for orientation, search, capture, entry and relation management, collections, labels, workflows, and session tracking. The agent reads what governs the work before it acts, and writes decisions and tensions back as it learns them.
+
+Prefer the terminal? [`@productbrain/cli`](https://www.npmjs.com/package/@productbrain/cli) exposes the same Chain as `pb`.
+
+## Links
+
+- Product Brain — https://work.productbrain.io
+- Issues — https://github.com/synergyai-os/Product-OS/issues