@cloudgrid-io/mcp 0.13.0 → 0.14.0

package/src/corpus/templates/approval-workflow/AGENTS.md

@@ -0,0 +1,170 @@
+# AGENTS.md — approval-workflow (blueprint)
+
+A multi-step approval system: a requester submits a **request**, it advances
+through an ordered chain of **approval steps**, each step is decided (approve /
+reject / delegate) by an assigned approver **role**, and every action is
+recorded. This is a **blueprint** — a structure guide, not app code. Read it,
+then build the Next.js + Mongo app on the grid following the shape below.
+
+The proven base shape is `app-with-data` (Next.js + Mongo, App Router, lazy DB
+getter). This blueprint extends it with a state machine, roles, and
+notifications. Fetch that template for the concrete Mongo/CRUD wiring:
+`gridctl_fetch("template", "app-with-data")`, then adapt it to the collections
+here.
+
+## 1. File tree
+
+Service code MUST live under `services/web/` — `path: /` in `cloudgrid.yaml` is
+the URL mount, NOT the filesystem path. Files at the root fail with
+`Error: Service directory not found: …/services/web`.
+
+```
+cloudgrid.yaml                               # name + services.web (nextjs) + needs:{database:true} (+ vault: for auth)
+services/web/package.json                    # next, react, react-dom, mongodb (+ auth provider SDK, + stripe if used)
+services/web/middleware.js                   # auth provider middleware — gates /dashboard + /api behind sign-in
+services/web/lib/db.js                        # lazy Mongo client from DATABASE_MONGODB_URL (legacy MONGODB_URL fallback)
+services/web/lib/workflow.js                  # state machine: advance/decide a request across its ordered steps
+services/web/lib/auth.js                       # read current user + role from the auth provider session
+services/web/lib/notify.js                     # send step-assigned / decided notifications (email/Slack connector)
+services/web/app/layout.js                     # root layout + auth provider wrapper
+services/web/app/page.js                       # server component: my requests + requests awaiting my approval
+services/web/app/request-form.js               # client: create a request, choose the approval chain
+services/web/app/requests/[id]/page.js         # server: one request, its steps, timeline, decide buttons
+services/web/app/requests/[id]/decide.js       # client: approve / reject / delegate the current step
+services/web/app/api/requests/route.js         # GET (list mine/pending) / POST (create request + seed steps)
+services/web/app/api/requests/[id]/route.js    # GET one request (with steps + audit)
+services/web/app/api/requests/[id]/decide/route.js  # POST a decision → advances the state machine
+services/web/app/api/webhooks/auth/route.js    # auth provider webhook: upsert users into the `users` collection
+```
+
+If an approval gates a payment, add
+`services/web/app/api/checkout/route.js` (create a Stripe Checkout session) and
+`services/web/app/api/webhooks/stripe/route.js` (mark the request paid on
+`checkout.session.completed`).
+
+## 2. Mongo collections
+
+The grid provisions one Mongo database (see wiring below). Model these
+collections in it:
+
+**`users`** — one per person, mirrored from the auth provider.
+- `_id` (ObjectId), `authId` (provider user id, unique), `email`, `name`,
+  `role` (enum: `requester` | `approver` | `admin`), `createdAt`.
+
+**`requests`** — one per approval request (the aggregate root).
+- `_id`, `title`, `description`, `amount` (optional, if it gates a payment),
+  `requesterId` (→ users), `status` (enum: `pending` | `approved` | `rejected`
+  | `cancelled`), `currentStep` (int, 0-based index into `steps`), `createdAt`,
+  `updatedAt`.
+
+**`steps`** — the ordered approval chain for a request (or embed as a `steps: []`
+array on the request document — either works; a separate collection scales better
+for querying "awaiting my approval").
+- `_id`, `requestId` (→ requests), `order` (int, 0-based), `approverRole`
+  (which role decides this step) or `approverId` (a specific user),
+  `status` (enum: `waiting` | `active` | `approved` | `rejected` | `skipped`),
+  `decidedBy` (→ users, nullable), `decidedAt` (nullable), `comment`.
+
+**`audit`** — append-only event log (never mutate/delete rows).
+- `_id`, `requestId`, `actorId` (→ users), `action` (enum: `created` |
+  `approved` | `rejected` | `delegated` | `cancelled`), `at`, `detail`.
+
+Suggested indexes: `requests.requesterId`, `requests.status`,
+`steps.requestId + order`, `steps.approverRole + status`, `audit.requestId + at`.
+
+## 3. The state machine (`lib/workflow.js`)
+
+The core of this blueprint. Keep the transitions in one module so both the API
+routes and the UI agree on what is legal.
+
+- **Create**: seed the `steps` for the request from the chosen chain; set
+  `steps[0].status = active`, the rest `waiting`; `request.status = pending`,
+  `request.currentStep = 0`; append `audit(created)`.
+- **Approve current step**: only the assigned role/user may decide; mark the
+  active step `approved`; if a next step exists, set it `active` and bump
+  `currentStep`; else set `request.status = approved`. Append `audit(approved)`.
+- **Reject current step**: mark it `rejected`, set `request.status = rejected`,
+  mark remaining `waiting` steps `skipped`. Append `audit(rejected)`.
+- **Delegate**: reassign the active step's `approverId` to another user, append
+  `audit(delegated)` — the step stays `active`.
+- Guard every transition against the current `status`/`currentStep` server-side;
+  never trust the client to say which step is active.
+- Fire `lib/notify.js` on step activation (notify the new approver) and on final
+  decision (notify the requester).
+
+## 4. How CloudGrid injects everything
+
+- **Mongo (the datastore):** you declare `needs: { database: true }` in
+  `cloudgrid.yaml`. You do NOT provision a DB or set a connection string. The
+  deployer provisions shared Mongo and injects the connection string as the
+  **`DATABASE_MONGODB_URL`** env var (plus the legacy **`MONGODB_URL`** alias) at
+  dev-time (`grid dev`) and at runtime (after `grid plug`). Read it in
+  `lib/db.js` via `process.env.DATABASE_MONGODB_URL || process.env.MONGODB_URL`
+  **lazily, inside the getter — never at module top level**, or `next build`
+  fails when it imports the module for route analysis before the var exists.
+- **Secrets (auth / payments) via the `vault:` block:** the CloudGrid-correct way
+  to inject secrets is the `vault:` block in `cloudgrid.yaml`, which maps a vault
+  item to an env var. This blueprint's yaml has a commented `vault:` block —
+  uncomment it and store the real value with `grid secrets set`, then the
+  deployer injects it as an env var:
+  ```yaml
+  vault:
+    AUTH_PROVIDER_KEY: auth-provider-secret-key   # → process.env.AUTH_PROVIDER_KEY
+    # STRIPE_KEY: stripe-live-key                  # → process.env.STRIPE_KEY (if a step gates a payment)
+    # SENDGRID_API_KEY: sendgrid-key               # → process.env.SENDGRID_API_KEY (email notifications)
+  ```
+  Do NOT hardcode keys and do NOT set `DATABASE_MONGODB_URL`/`MONGODB_URL`
+  yourself — the grid injects the DB vars.
+- **AI (optional):** if you add AI (e.g. auto-summarize a request), declare
+  `needs: { ai: true }`; the grid injects **`AI_GATEWAY_URL`** and you call it
+  through `@cloudgrid-io/ai`.
+- **Non-secret config** → `grid env`. **Secrets** → `grid secrets set` (mapped by
+  `vault:`).
+
+## 5. Wiring auth (roles) and payments
+
+**Auth + roles (required — approvals need to know who you are):**
+1. Add an auth provider SDK to `package.json` (e.g. `@clerk/nextjs` or the Auth0
+   Next.js SDK).
+2. Put the provider's publishable key in `services/web/app/layout.js` (client
+   wrapper) and the secret key in `process.env.AUTH_PROVIDER_KEY` (from the
+   `vault:` block — never inline it).
+3. `services/web/middleware.js` gates `/dashboard`, `/requests/*`, and `/api/*`
+   behind sign-in.
+4. `lib/auth.js` reads the current user + `role` from the session; the state
+   machine uses `role` to decide who may approve a given step.
+5. `app/api/webhooks/auth/route.js` receives the provider's user-created/updated
+   webhook and upserts the person into the `users` collection with a default
+   `role: requester`.
+
+**Payments (optional — only if an approved request triggers a charge):**
+1. Add `stripe` to `package.json`; put the key in `STRIPE_KEY` via `vault:`.
+2. `app/api/checkout/route.js` creates a Checkout session after the request
+   reaches `approved`.
+3. `app/api/webhooks/stripe/route.js` verifies the signature and, on
+   `checkout.session.completed`, records payment on the `requests` document.
+
+## 6. Deploy steps
+
+1. `gridctl_init` an app `<name>` — creates the entity, `.cloudgrid/link.json`,
+   and a `cloudgrid.yaml` with an empty `services: {}`. Run `init` FIRST because
+   `plug` needs a linked directory.
+2. Fill `cloudgrid.yaml` to this blueprint's shape (copy this template's file):
+   `services.web { type: nextjs, path: / }` + `needs: { database: true }` +
+   (uncomment) the `vault:` block for `AUTH_PROVIDER_KEY`.
+3. Write the app under `services/web/` following the file tree above.
+4. `grid secrets set` the auth provider key (and Stripe/SendGrid keys if used);
+   they are injected via the `vault:` mapping.
+5. (Optional) `grid dev` to run locally against injected Mongo before deploying.
+6. `grid plug` to deploy. A runtime deploy is **async** — the first response is
+   `status: building`, not a live URL. Poll `grid status` (surface a liveness
+   signal, never a bare silent wait) until it is live, then return the live app
+   URL. Re-plug the SAME entity to update the same URL.
+
+## 7. Edition note
+
+This is a built + deployed container (a **runtime** app), so it requires the
+**local edition** (Claude Code / Claude Desktop) or the CLI. The **hosted**
+edition (Claude Web / hosted MCP) is inline-only and can publish only static
+pages — it CANNOT build this runtime app. On hosted, tell the user plainly and
+offer a static mock instead; do not attempt the runtime path there.

package/src/corpus/templates/approval-workflow/README.md

@@ -0,0 +1,12 @@
+# approval-workflow template (blueprint)
+
+A multi-step approval system: a requester submits a request, it advances through
+an ordered chain of approval steps decided by assigned roles (approve / reject /
+delegate), every action is recorded in an append-only audit log, and approvers
+are notified as each step activates. It is a persistent Next.js + Mongo runtime
+app (declares `needs: { database: true }`, extends the proven `app-with-data`
+shape) with auth-provider roles wired through a `vault:` secret. This is a
+**blueprint: structure + cloudgrid.yaml — adapt and build.** Read `AGENTS.md`
+for the full file tree, Mongo collections, the state machine, CloudGrid wiring
+(DB injection, `vault:` secrets, deploy), then build the app following it. There
+is no shipped app code here.

package/src/corpus/templates/approval-workflow/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: approval-workflow
+
+# 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 approval-workflow signs approvers in with an auth provider (Clerk/Auth0).
+# Uncomment the vault block below and store the real key with `grid secrets set`
+# so the deployer injects it as an env var — never hardcode provider keys.
+# vault:
+#   AUTH_PROVIDER_KEY: auth-provider-secret-key
+#   # Add SENDGRID_API_KEY: sendgrid-key for email approval notifications, or
+#   # STRIPE_KEY: stripe-live-key if an approval gates a payment/checkout.
+
+
+# ─── 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/approval-workflow/index.md

@@ -0,0 +1,58 @@
+# Template: approval-workflow (blueprint — Next.js + Mongo)
+
+A multi-step approval system: a requester submits a **request**, it advances
+through an ordered chain of **approval steps** decided by assigned **roles**
+(approve / reject / delegate), every action lands in an append-only **audit**
+log, and approvers are notified as each step activates. Persistent Next.js +
+Mongo runtime app (`needs: { database: true }`), extending the proven
+`app-with-data` shape with a state machine, auth-provider roles, and
+notifications.
+
+**This is a BLUEPRINT — structure + cloudgrid.yaml, not shipped app code.**
+Read `AGENTS.md` (fetch this bundle) for the file tree, collections, state
+machine, and CloudGrid wiring, then build the app under `services/web/`.
+
+## Fetch bundle
+
+- `gridctl_fetch("template", "approval-workflow")` → this blueprint:
+  - `AGENTS.md` — file tree, Mongo collections (`users`, `requests`, `steps`,
+    `audit`), the state machine, auth/payments wiring, deploy steps, edition note.
+  - `cloudgrid.yaml` — the full-annotated reference with only `name`,
+    `services.web { type: nextjs, path: / }`, and `needs: { database: true }`
+    active, plus a commented `vault:` block for `AUTH_PROVIDER_KEY`.
+  - `README.md` — one-paragraph what/why.
+- `gridctl_fetch("template", "app-with-data")` → the concrete Next.js + Mongo
+  CRUD wiring (lazy `lib/db.js`, App Router route, server page) to adapt from.
+
+## Key rules
+
+1. **Blueprint, not code** — read `AGENTS.md` and build; nothing ships here to run.
+2. **Service code lives under `services/web/`.** `path: /` is the URL mount, NOT
+   the filesystem path.
+3. **Declare `needs: { database: true }`** (the canonical shape). The deployer
+   provisions Mongo and injects `DATABASE_MONGODB_URL` (plus the legacy
+   `MONGODB_URL` alias). Never set `needs:` and `requires:` together; never
+   author `requires:`.
+4. **Read the DB string lazily** inside the `getDb` getter
+   (`process.env.DATABASE_MONGODB_URL || process.env.MONGODB_URL`), never at
+   module top level, or `next build` fails.
+5. **Secrets via the `vault:` block** → env vars (e.g. `AUTH_PROVIDER_KEY`,
+   `STRIPE_KEY`); store real values with `grid secrets set`, never hardcode.
+6. **Runtime app → local edition only.** Deploy with `grid plug` (async — poll
+   to a live URL). Hosted (Claude Web) can only publish static pages.
+
+## 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 (plus a commented vault: block to
+# uncomment for the auth provider secret).
+name: approval-workflow
+services:
+  web:
+    type: nextjs
+    path: /
+needs:
+  database: true
+```