@cloudgrid-io/mcp 0.13.0 → 0.15.0

package/src/corpus/templates/forum/AGENTS.md

@@ -0,0 +1,196 @@
+# forum — structure guide (BLUEPRINT)
+
+This is a **blueprint**, not runnable app code. It gives you the exact structure
+to build a threaded community forum on CloudGrid: a Next.js app under
+`services/web/`, backed by grid-shared MongoDB, with sign-in-to-post auth via a
+hosted provider (Clerk / Auth0) whose keys come from the org vault. Build the app
+by following this guide; the shape mirrors the proven `app-with-data` template
+(lazy Mongo getter, App-Router API routes, `needs: { database: true }`).
+
+---
+
+## 1. File tree
+
+Build exactly this layout. **App code MUST live under `services/web/`** — the
+service is named `web`, so the CLI looks for `services/web/`. `path: /` in
+`cloudgrid.yaml` is the URL mount, NOT the filesystem path. Files at the repo
+root fail with `Error: Service directory not found: …/services/web`.
+
+```
+cloudgrid.yaml                                  # name + services.web (nextjs) + needs:{database:true} + vault: (auth keys)
+services/web/package.json                       # next, react, react-dom, mongodb, + auth provider SDK (e.g. @clerk/nextjs)
+services/web/middleware.js                      # auth provider middleware — protects write routes, exposes read routes
+services/web/lib/db.js                           # lazy Mongo client from DATABASE_MONGODB_URL (legacy MONGODB_URL fallback)
+services/web/lib/auth.js                         # helper: resolve current user (id + display name) from the provider session
+services/web/app/layout.js                       # root layout: wraps children in the provider <ClerkProvider>/<Auth0Provider>, sign-in button
+services/web/app/page.js                         # server component: lists threads (newest / most-active)
+services/web/app/thread/[id]/page.js             # server component: one thread + its nested reply tree
+services/web/app/thread/[id]/reply-form.js       # client component: post a reply (sign-in gated)
+services/web/app/new-thread.js                   # client component: create a thread (sign-in gated)
+services/web/app/api/threads/route.js            # GET list threads / POST create thread (auth required to POST)
+services/web/app/api/threads/[id]/route.js       # GET one thread / DELETE (author or moderator only)
+services/web/app/api/posts/route.js              # GET posts for a thread / POST a reply (auth required, supports parentId for nesting)
+services/web/app/api/posts/[id]/route.js         # DELETE / PATCH a post — moderation (author or moderator)
+```
+
+Keep the UI minimal (inline CSS in `layout.js`, same as `app-with-data`). The
+domain, not styling, is what this blueprint is about.
+
+---
+
+## 2. MongoDB collections + fields
+
+The grid provisions MongoDB from `needs: { database: true }`. Model three
+collections. Store the provider's user id as `authorId` on every authored
+document — do not copy PII beyond a display name.
+
+**`users`** — a thin local mirror of the auth-provider identity (upserted on
+first post; the provider remains the source of truth for auth).
+| field         | type     | notes                                              |
+|---------------|----------|----------------------------------------------------|
+| `_id`         | ObjectId | Mongo id                                           |
+| `authorId`    | string   | provider user id (Clerk/Auth0 `sub`), **unique**   |
+| `displayName` | string   | shown next to posts                                |
+| `role`        | string   | `member` (default) or `moderator`                  |
+| `createdAt`   | Date     |                                                    |
+
+**`threads`** — one row per discussion topic.
+| field         | type     | notes                                              |
+|---------------|----------|----------------------------------------------------|
+| `_id`         | ObjectId | thread id (used in `/thread/[id]`)                 |
+| `title`       | string   | required, trimmed                                  |
+| `authorId`    | string   | provider user id of the creator                    |
+| `authorName`  | string   | denormalized display name                          |
+| `replyCount`  | number   | denormalized, bumped on each reply                 |
+| `createdAt`   | Date     | sort key for "newest"                              |
+| `lastPostAt`  | Date     | sort key for "most-active"                         |
+
+**`posts`** — every reply. Nesting is by `parentId` (self-referential adjacency
+list); the top-level post of a thread has `parentId: null`.
+| field         | type            | notes                                       |
+|---------------|-----------------|---------------------------------------------|
+| `_id`         | ObjectId        | post id                                     |
+| `threadId`    | ObjectId        | which thread this belongs to (indexed)      |
+| `parentId`    | ObjectId / null | reply target; `null` = direct thread reply  |
+| `authorId`    | string          | provider user id                            |
+| `authorName`  | string          | denormalized display name                   |
+| `body`        | string          | required, trimmed                           |
+| `deleted`     | boolean         | soft-delete for moderation (keeps tree)     |
+| `createdAt`   | Date            | sort within a nesting level                 |
+
+Recommended indexes: `posts.threadId`, `posts.parentId`, unique
+`users.authorId`, `threads.lastPostAt`.
+
+**Render nested replies** by fetching all posts for a thread (`{ threadId }`),
+then building the tree in memory from `parentId` — one query, arbitrary depth.
+For a soft-deleted post keep the node so its children stay reachable; render its
+body as "[removed]".
+
+---
+
+## 3. How CloudGrid injects things
+
+You never provision infra or set connection strings by hand. Declared needs and
+vault mappings become environment variables at **both** `next build` / `grid
+dev` and runtime.
+
+- **Database (`needs: { database: true }`)** → the grid provisions MongoDB and
+  injects **`DATABASE_MONGODB_URL`** (plus the legacy **`MONGODB_URL`** alias).
+  Read it as `process.env.DATABASE_MONGODB_URL || process.env.MONGODB_URL`
+  **lazily, inside the getter in `lib/db.js`** — never at module top level, or
+  `next build` throws when it imports the module for route analysis before the
+  var exists.
+- **Auth secrets (`vault:` block)** → each `ENV_VAR: vault-item-key` mapping
+  injects that vault item as `process.env.ENV_VAR`. This blueprint maps
+  `AUTH_PROVIDER_SECRET_KEY` and `AUTH_PROVIDER_PUBLISHABLE_KEY`. Rename the env
+  keys to whatever the provider SDK expects (see §4) and set the vault items with
+  `gridctl_secrets` / the org vault — do not commit keys.
+- **AI (optional)** — if you add `needs: { ai: true }` (e.g. auto-moderation or
+  summarize-thread), the grid injects **`AI_GATEWAY_URL`**; call it via
+  `@cloudgrid-io/ai`. Not required for the base forum.
+- **Reserved vars** you must NOT set yourself: `PORT`, `NODE_ENV`,
+  `DATABASE_MONGODB_URL`, `MONGODB_URL`, `REDIS_URL`, `AI_GATEWAY_URL`,
+  `CLOUDGRID_*`.
+
+`lib/db.js` — copy the lazy-getter pattern from `app-with-data`:
+
+```js
+import { MongoClient } from "mongodb";
+function clientPromise() {
+  const uri = process.env.DATABASE_MONGODB_URL || process.env.MONGODB_URL;
+  if (!uri) throw new Error("DATABASE_MONGODB_URL not set — run with grid dev or grid plug.");
+  if (!globalThis.__mongoClientPromise) globalThis.__mongoClientPromise = new MongoClient(uri).connect();
+  return globalThis.__mongoClientPromise;
+}
+export async function getDb() { return (await clientPromise()).db(); }
+```
+
+---
+
+## 4. Wiring auth (sign-in-to-post)
+
+Reading threads is public; **posting requires a signed-in member**. Use a hosted
+auth provider so you don't build password handling. Two common choices:
+
+- **Clerk** — add `@clerk/nextjs`. The SDK reads `CLERK_SECRET_KEY` and
+  `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY`. Map the vault to those exact env names in
+  `cloudgrid.yaml` (rename `AUTH_PROVIDER_SECRET_KEY` →
+  `CLERK_SECRET_KEY`, `AUTH_PROVIDER_PUBLISHABLE_KEY` →
+  `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY`). Wrap `app/layout.js` in
+  `<ClerkProvider>`, add `<SignInButton>` / `<UserButton>`, and in
+  `middleware.js` protect the write routes.
+- **Auth0** — add `@auth0/nextjs-auth0`; it reads `AUTH0_SECRET`,
+  `AUTH0_CLIENT_ID`, `AUTH0_CLIENT_SECRET`, `AUTH0_BASE_URL`, `AUTH0_ISSUER_BASE_URL`.
+  Map the vault items to those names.
+
+Wiring pattern regardless of provider:
+
+1. `middleware.js` — mark `GET /`, `GET /thread/*`, and the read (`GET`) API
+   routes as public; require a session for `POST`/`PATCH`/`DELETE`.
+2. `lib/auth.js` — resolve the current user server-side (`auth()` in Clerk,
+   `getSession()` in Auth0). Return `{ authorId, displayName }` or `null`.
+3. In each write route: call the auth helper; if `null`, return `401`. On the
+   first authored action, **upsert** the user into the `users` collection
+   (keyed by `authorId`) so display names + roles are local.
+4. **Moderation** — a `DELETE`/`PATCH` on a post or thread is allowed only when
+   the caller's `authorId` matches the document's `authorId` OR the caller's
+   `users.role === "moderator"`. Prefer **soft delete** (`deleted: true`) on
+   posts so the reply tree stays intact.
+
+The `vault:` block is the CloudGrid-correct way to inject these secrets — never
+inline a key in code or `env:`.
+
+---
+
+## 5. Deploy steps
+
+A forum is a runtime (built + deployed container) app — **local edition**
+(Claude Desktop / Claude Code / CLI), async build.
+
+1. `gridctl_login_status` → `gridctl_login` if needed. Respect the grid picker
+   (ask which grid if the user has more than one).
+2. `gridctl_init` an app `<name>` — creates the entity + `.cloudgrid/link.json`
+   and a `cloudgrid.yaml` with empty `services: {}`. Run `init` FIRST (`plug`
+   needs a linked dir).
+3. Write the app under `services/web/` per §1, then fill `cloudgrid.yaml` to the
+   active shape: `name`, `services.web { type: nextjs, path: / }`, `needs:
+   { database: true }`, and the `vault:` mappings for the auth keys.
+4. Set the auth secrets: `gridctl_secrets` (or the org vault) for the provider
+   keys. Do NOT set `DATABASE_MONGODB_URL` — the grid injects it.
+5. (Optional) `grid dev` to run locally against injected Mongo before shipping.
+6. `gridctl_plug` to deploy. A runtime deploy is **ASYNC** — the first response
+   is `status: building`, not a live URL. Poll `gridctl_status` (or the returned
+   poll_url) until live; surface a liveness signal while it builds, never a bare
+   spinner.
+7. Only once live, return the deployed app URL. Re-plug the SAME entity to update
+   the same URL.
+
+---
+
+## 6. Edition note
+
+This blueprint targets a **runtime** deploy, which requires the **local
+edition**. The hosted edition (Claude Web / hosted MCP) is inline-only and can
+only publish static pages — it CANNOT build this containerized Next.js + Mongo +
+auth forum. On hosted, either switch to a local edition or offer a static,
+read-only mock instead and stop the runtime path.

package/src/corpus/templates/forum/README.md

@@ -0,0 +1,12 @@
+# forum template — threaded community forum (BLUEPRINT)
+
+A community discussion board where members sign in to start threads and post
+nested replies, with moderation — a persistent Next.js app under `services/web/`
+backed by grid-shared MongoDB (`threads` / `posts` / `users`), with sign-in-to-post
+auth via a hosted provider (Clerk / Auth0) whose keys come from the org vault.
+This is a **blueprint**: it ships the structure and the `cloudgrid.yaml`, not
+runnable app code — read `AGENTS.md` for the file tree, Mongo schema, CloudGrid
+wiring (DATABASE_MONGODB_URL, vault→env secrets), auth/moderation, and the
+`grid init → fill → grid plug → poll` deploy flow, then adapt and build the app.
+
+See `AGENTS.md` for the full structure guide.

package/src/corpus/templates/forum/cloudgrid.yaml

@@ -0,0 +1,237 @@
+# ============================================================================
+# cloudgrid.yaml — Complete Example
+# ============================================================================
+#
+# This file shows EVERY field the platform supports, with comments explaining
+# each one. It is a reference — no real project would use all of these at once.
+#
+# STANDARD: every CloudGrid template ships its cloudgrid.yaml in THIS full form.
+# Uncomment ONLY the fields the archetype needs (always: name + services; plus
+# needs: for runtime apps). Leave everything else commented. Comments are
+# ignored by the parser, so the file deploys to exactly the active fields.
+#
+# Only two fields are required: name and services. Everything else is optional.
+# Full docs: docs/cloudgrid-yaml-reference.md
+# ============================================================================
+
+
+# ─── IDENTITY ───────────────────────────────────────────────────────────────
+
+# Entity slug (REQUIRED). 2-42 chars, lowercase alphanumeric + hyphens.
+# Must start and end with a letter or digit.
+# Becomes part of your public URL: <name>-<4hex>.<org>.cloudgrid.io
+name: forum
+
+# One-line summary. Max 280 chars. If omitted, Grid Brain auto-generates one.
+# description: Order processing API for the e-commerce platform
+
+# Single emoji or short text shown as the entity icon. Max 64 chars.
+# icon: "📦"
+
+# Entity type: 'app' (default) or 'agent'. An agent is an app with an agent: block.
+# kind: app
+
+
+# ─── NETWORKING ─────────────────────────────────────────────────────────────
+
+# Whether this entity serves public HTTP traffic.
+# true = public URL + Ingress (default). false = internal only.
+# expose: true
+
+# Additional domain names this entity serves on (the platform URL is always active).
+# custom_domains:
+#   - orders.example.com
+#   - shop.example.com
+
+
+# ─── HEALTH PROBE (entity-level override) ──────────────────────────────────
+
+# Override the default health check for the entire entity.
+# probe:
+#   path: /healthz               # HTTP path to probe (default: /).
+#   expected: "<500"             # '<500' (default), '200', '2xx'.
+
+
+# ─── DEPLOY NOTIFICATIONS ──────────────────────────────────────────────────
+
+# Slack notification to the org's default channel on deploy failure.
+# true = notify (default), false = silent.
+# notify: true
+
+
+# ─── SCALING ────────────────────────────────────────────────────────────────
+
+# Replica scaling intent.
+#   'auto'  — platform decides from the grid tier (default).
+#   'alert' — single-replica, emit a SPOF warning at plug time.
+#   1-10    — explicit replica count, clamped to the grid max.
+# scale: auto
+
+
+# ─── INFRASTRUCTURE NEEDS ──────────────────────────────────────────────────
+#
+# Declare infrastructure; the platform provisions it and injects connection
+# details as env vars. Nine needs: database, cache, kv, queue, pubsub, vector,
+# object_storage, disk, ai. Simplest form is `true`.
+#
+# needs:
+#   # database — MongoDB. Injects DATABASE_MONGODB_URL (+ legacy MONGODB_URL).
+#   #   true | pool | dedicated | { tier: external, secret: MY_DB }
+#   database: true
+#   # cache — Redis, LRU eviction (derived data). Injects CACHE_REDIS_URL (+ REDIS_URL).
+#   #   true | redis | { engine: external, secret: MY_REDIS_URL }
+#   cache: true
+#   # kv — Redis, no eviction (durable: flags, idempotency). Injects KV_REDIS_URL.
+#   kv: true
+#   # queue — Redis job-queue substrate (BullMQ). Injects QUEUE_REDIS_URL.
+#   queue: true
+#   # pubsub — Redis broadcast pub/sub. Injects PUBSUB_REDIS_URL.
+#   pubsub: true
+#   # vector — pgvector on Postgres. Injects VECTOR_PGVECTOR_URL (+ PGVECTOR_URL).
+#   #   true | pgvector | { engine: pgvector, dim: 1536 }
+#   vector: pgvector
+#   # object_storage — GCS bucket. Injects OBJECT_STORAGE_GCS_BUCKET, _GCS_REGION.
+#   #   true | { size: 10Gi }
+#   object_storage: true
+#   # disk — persistent FS mount (PVC). Injects DISK_PATH. Pins to 1 replica.
+#   #   true | { size: 1Gi, mount: /var/data }  (forbidden: /proc /sys /dev)
+#   disk: true
+#   # ai — AI Gateway via @cloudgrid-io/ai. Injects AI_GATEWAY_URL. true | false.
+#   ai: true
+
+
+# ─── INTER-ENTITY COMMUNICATION ────────────────────────────────────────────
+
+# Entities this app calls (outbound). Service-account token injected per pair.
+# calls:
+#   - org:atomic/billing-api
+
+# Inbound caller policy — who can call YOUR entity.
+# callers:
+#   policy: auto                 # 'auto' | 'manual' (default).
+#   scope: org                   # 'org' (default) | 'space' | 'explicit'.
+#   fallback: deny               # 'deny' (default) | 'warn'.
+#   # allowed_apps:              # required only when scope: explicit
+#   #   - org:atomic/frontend
+
+
+# ─── VAULT ──────────────────────────────────────────────────────────────────
+#
+# Map org vault items to env vars. Keys UPPER_SNAKE_CASE; values = vault item keys.
+# This forum uses a hosted auth provider (Clerk/Auth0) so members must sign in to
+# post. Store the provider's secret + publishable keys as org vault items, then
+# map them to env vars here. The grid injects them at build + runtime — never
+# hardcode a key or commit one to the repo.
+vault:
+  AUTH_PROVIDER_SECRET_KEY: auth-provider-secret-key
+  AUTH_PROVIDER_PUBLISHABLE_KEY: auth-provider-publishable-key
+
+
+# ─── CONNECTORS AND HOOKS ──────────────────────────────────────────────────
+
+# connectors:
+#   - id: team-slack
+#     target: org                # 'system' | 'org'.
+#     channel: "#deploys"
+# hooks:
+#   - on: deploy.failed          # release.published | deploy.failed | feedback.received | entity.created
+#     via: team-slack
+#     template: "Deploy failed for {entity_name}: {error}"
+#     channel: "#alerts"
+# triggers:
+#   - from: team-slack
+#     event: message
+#     channel: "#support"
+#     route: /webhooks/slack
+
+
+# ─── LOCAL DEVELOPMENT ──────────────────────────────────────────────────────
+
+# Config for `grid dev`. Redact fields in dev data snapshots.
+# dev:
+#   snapshot:
+#     mask:
+#       - users.email
+#       - users.phone
+
+
+# ─── AGENT METADATA ────────────────────────────────────────────────────────
+
+# An agent is an app with kind: agent (above) and an agent: block.
+# agent:
+#   purpose: Sync customer data from external CRM every night
+#   schedule: "0 2 * * *"
+#   trigger: webhook
+
+
+# ─── PRIVATE RESOURCE AUTO-DEPENDENCIES ────────────────────────────────────
+
+# When true (default), private resources are auto-injected as depends_on.
+# auto_depends_on_private_requires: true
+
+
+# ─── SERVICES (REQUIRED) ───────────────────────────────────────────────────
+#
+# At least one service is required. Key = service name (slug rules).
+# Types: node, nextjs, python, static, cron.
+#
+services:
+  web:
+    # type (REQUIRED): node | nextjs | python | static | cron
+    type: nextjs
+    # HTTP route: '/' | '/api' | false (internal) | omitted (=false + warning).
+    # Only one service per entity can claim '/'.
+    path: /
+    # Container port (default 8080; read process.env.PORT). Not for cron.
+    # port: 3000
+    # nextjs only: base_image: distroless (default) | alpine
+    # base_image: distroless
+    # node only: lang: javascript (default) | typescript
+    # lang: typescript
+    # Custom source location (default services/<name>/). '.' = project root.
+    # source:
+    #   path: src/worker
+    # Health probe: false/omitted (TCP) | true (/health) | "/path" | {path,expected}
+    # health:
+    #   path: /api/health
+    #   expected: "200"
+    # Static runtime env vars (strings). Reserved: PORT, APP_NAME, SERVICE_NAME,
+    # NODE_ENV, MONGODB_URL, REDIS_URL, AI_GATEWAY_URL, N8N_WEBHOOK_URL, CLOUDGRID_*.
+    # env:
+    #   LOG_LEVEL: info
+    # Sibling services/private resources that must be Ready first (no cron, no cycles).
+    # depends_on:
+    #   - worker
+    # Per-service needs override (merges with app-level needs).
+    # needs:
+    #   queue: true
+    # Static-only build step:
+    # build:
+    #   command: npm run build
+    #   output: dist
+    #   env:
+    #     VITE_API_URL: https://api.example.com
+    # node_version: "22"          # static build step: '18'|'20'|'22'|'24' (quoted)
+    # Cron-only: schedule (REQUIRED), timezone (UTC|EST|PST), run (job | https URL)
+    # schedule: "0 9 * * 1"
+    # timezone: UTC
+    # run: job
+    # Verbose per-service persistence (prefer needs.disk):
+    # persist:
+    #   - name: scratch
+    #     path: /tmp/scratch
+    #     size: 500Mi
+
+
+
+needs:
+  database: true
+
+
+# ============================================================================
+# NOTES
+# - NOT here: org:/entity_id: (→ .cloudgrid/link.json), secrets (→ grid secrets set),
+#   Dockerfile (platform generates from services.*.type).
+# - Deploy: grid plug   |   Local with grid resources: grid dev
+# - Full reference: docs/cloudgrid-yaml-reference.md  |  CLI: docs/cli-reference.md
+# ============================================================================

package/src/corpus/templates/forum/index.md

@@ -0,0 +1,66 @@
+# Template: forum (BLUEPRINT — threaded community forum)
+
+A persistent, sign-in-to-post community forum: `threads` → nested `posts` with
+moderation, on Next.js + grid-shared MongoDB, auth via a hosted provider
+(Clerk / Auth0). This is a **blueprint** — it gives you the structure and
+`cloudgrid.yaml`, NOT runnable app code. Read `AGENTS.md`, then build the app
+under `services/web/` following it. The shape mirrors the proven `app-with-data`
+template (lazy Mongo getter, App-Router routes, `needs: { database: true }`).
+
+**Fetch the bundle:** `gridctl_fetch("template", "forum")` returns this
+directory — `cloudgrid.yaml`, `AGENTS.md` (the structure guide), and this file.
+
+**Key rules:**
+
+1. **App code MUST live under `services/web/`.** `path: /` is the URL mount, not
+   the filesystem path. Root files fail with `Service directory not found`.
+2. **Read the DB connection LAZILY** in `lib/db.js` —
+   `process.env.DATABASE_MONGODB_URL || process.env.MONGODB_URL` inside the
+   getter, never at module top level (a top-level read fails `next build`). The
+   grid injects it from `needs: { database: true }`. Never hardcode it.
+3. **Declare `needs: { database: true }`** — the canonical shape. Never author
+   `requires:`, and never set `needs:` and `requires:` together (the validator
+   rejects the combination).
+4. **Auth secrets come from the `vault:` block** → env vars, injected by the
+   grid at build + runtime. Never inline a provider key.
+5. **Runtime app → local edition, async deploy.** `grid plug` returns
+   `status: building`; poll to a live URL.
+
+## cloudgrid.yaml
+
+```yaml
+# On disk this file is the full-annotated reference (templates/_cloudgrid.yaml.reference)
+# with EVERY field present as a comment; only the fields below are uncommented,
+# so it deploys to exactly these active fields.
+name: forum
+services:
+  web:
+    type: nextjs
+    path: /
+vault:
+  AUTH_PROVIDER_SECRET_KEY: auth-provider-secret-key
+  AUTH_PROVIDER_PUBLISHABLE_KEY: auth-provider-publishable-key
+needs:
+  database: true
+```
+
+> **Capability:** `needs: { database: true }` → the deployer provisions MongoDB
+> and injects `DATABASE_MONGODB_URL` (plus the legacy `MONGODB_URL` alias). The
+> `vault:` mappings inject the auth-provider keys as env vars. `requires:` is the
+> deprecated v1 alias — don't mix it with `needs:`.
+
+## Collections (see AGENTS.md for full fields)
+
+- **`users`** — thin mirror of the auth-provider identity (`authorId` unique,
+  `displayName`, `role: member|moderator`).
+- **`threads`** — `title`, `authorId`, `authorName`, `replyCount`, `createdAt`,
+  `lastPostAt`.
+- **`posts`** — `threadId`, `parentId` (self-referential for nesting; `null` =
+  top-level), `authorId`, `authorName`, `body`, `deleted` (soft-delete for
+  moderation), `createdAt`.
+
+## Build it
+
+Read `AGENTS.md` for the file tree, Mongo schema, secret injection, auth +
+moderation wiring, and deploy steps. Adapt the domain, then `grid dev` (local) /
+`grid plug` (deploy, async — poll to a live URL).