@cloudgrid-io/mcp 0.12.0 → 0.14.0

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

@@ -0,0 +1,233 @@
+# ============================================================================
+# 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: my-crm
+
+# 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.
+# vault:
+#   STRIPE_KEY: stripe-live-key
+#   SENDGRID_API_KEY: sendgrid-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/crm/index.md

@@ -0,0 +1,71 @@
+# Template: crm (persistent Next.js + Mongo contact manager)
+
+A real, deployable CRM. Contacts live in the grid-shared MongoDB, so they survive
+refresh and are shared across sessions. Same proven shape as `app-with-data`,
+adapted to a `contacts` domain (name, email, company, stage, note) with a table
+view and per-row stage changes.
+
+**Key rules (all proven by the app-with-data end-to-end deploy):**
+
+1. **Service code MUST live under `services/<name>/`, not the repo/template
+   root.** `path:` in `cloudgrid.yaml` is the URL mount, NOT the filesystem path.
+   The service named `web` → the CLI looks for `services/web/`. App files at the
+   root fail with `Error: Service directory not found: …/services/web`.
+2. **Read the DB connection string LAZILY (inside the getter), never at module
+   top level.** The grid injects it as `DATABASE_MONGODB_URL` (plus the legacy
+   `MONGODB_URL` alias) at dev-time and runtime; the app reads
+   `process.env.DATABASE_MONGODB_URL || process.env.MONGODB_URL` inside `getDb`.
+   A top-level read fails `next build`. Never hardcode a connection string; never
+   commit a secret.
+3. **Declare the datastore with `needs: { database: true }`.** The deployer
+   provisions Mongo and injects the connection string. `requires:` is the
+   deprecated v1 alias; don't author new yaml with it, and never set `needs:` and
+   `requires:` together (the validator rejects the combination).
+
+## File tree
+
+```
+cloudgrid.yaml                            # name + services.web (nextjs) + needs: { database: true }
+services/web/package.json                 # next, react, react-dom, mongodb driver only
+services/web/lib/db.js                    # lazy Mongo client from DATABASE_MONGODB_URL (legacy MONGODB_URL fallback)
+services/web/app/layout.js                # root layout + inline CSS
+services/web/app/page.js                  # server component: reads contacts from Mongo
+services/web/app/contact-manager.js       # client table: POST / PATCH (stage) / DELETE via the API
+services/web/app/api/contacts/route.js    # GET (list) / POST (add) / PATCH (stage) / DELETE (remove)
+```
+
+## 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: my-crm
+services:
+  web:
+    type: nextjs
+    path: /
+needs:
+  database: true
+```
+
+> **Capability:** this template's need is `database: true`. The deployer
+> provisions Mongo and injects `DATABASE_MONGODB_URL` (plus the legacy
+> `MONGODB_URL` alias). `requires:` is the deprecated v1 alias — don't mix it with
+> `needs:` (the validator rejects the combination). See the capability-map for
+> the full injection table.
+
+## The contacts collection
+
+Documents: `{ name, email, company, stage, note, createdAt }` where `stage` is
+one of `lead` / `qualified` / `customer`. The API route on `contacts` does GET
+(list), POST (add), PATCH (change stage), DELETE (remove); the page is a server
+component that reads the collection and hands it to a client table.
+
+## Adapt it
+
+- Rename the `contacts` collection to your data (`deals`, `companies`).
+- Change the document fields; add owners, timestamps, deal values.
+- Add more routes/collections as the CRM grows.
+- Add `cache: true` to `needs:` only if you actually need Redis.
+- Run `grid dev` to test locally, `grid plug` to deploy (async — poll to live).

package/src/corpus/templates/crm/services/web/app/api/contacts/route.js

@@ -0,0 +1,80 @@
+// App Router route handler for the `contacts` collection.
+// GET -> list contacts, POST -> add a contact, PATCH -> update stage/fields,
+// DELETE -> remove a contact by id.
+//
+// To adapt this app, rename the collection and change the fields to match your
+// own data (e.g. a `companies` or `deals` collection).
+import { NextResponse } from "next/server";
+import { ObjectId } from "mongodb";
+import { getDb } from "../../../lib/db.js";
+
+// Never cache — always read/write live data.
+export const dynamic = "force-dynamic";
+
+const STAGES = ["lead", "qualified", "customer"];
+
+async function contacts() {
+  const db = await getDb();
+  return db.collection("contacts");
+}
+
+function shape(c) {
+  return {
+    id: c._id.toString(),
+    name: c.name || "",
+    email: c.email || "",
+    company: c.company || "",
+    stage: STAGES.includes(c.stage) ? c.stage : "lead",
+    note: c.note || "",
+  };
+}
+
+// GET /api/contacts — list all contacts, newest first.
+export async function GET() {
+  const col = await contacts();
+  const items = await col.find({}).sort({ createdAt: -1 }).toArray();
+  return NextResponse.json(items.map(shape));
+}
+
+// POST /api/contacts — add a contact. Body: { name, email, company, stage, note }.
+export async function POST(request) {
+  const body = await request.json().catch(() => ({}));
+  const name = typeof body.name === "string" ? body.name.trim() : "";
+  if (!name) {
+    return NextResponse.json({ error: "name is required" }, { status: 400 });
+  }
+  const doc = {
+    name,
+    email: typeof body.email === "string" ? body.email.trim() : "",
+    company: typeof body.company === "string" ? body.company.trim() : "",
+    stage: STAGES.includes(body.stage) ? body.stage : "lead",
+    note: typeof body.note === "string" ? body.note.trim() : "",
+    createdAt: new Date(),
+  };
+  const col = await contacts();
+  const res = await col.insertOne(doc);
+  return NextResponse.json({ id: res.insertedId.toString(), ...doc }, { status: 201 });
+}
+
+// PATCH /api/contacts — update a contact's stage (or other fields). Body: { id, stage }.
+export async function PATCH(request) {
+  const body = await request.json().catch(() => ({}));
+  const { id, stage } = body;
+  if (!id || !ObjectId.isValid(id) || !STAGES.includes(stage)) {
+    return NextResponse.json({ error: "valid id and stage required" }, { status: 400 });
+  }
+  const col = await contacts();
+  await col.updateOne({ _id: new ObjectId(id) }, { $set: { stage } });
+  return NextResponse.json({ ok: true });
+}
+
+// DELETE /api/contacts?id=<id> — remove a contact.
+export async function DELETE(request) {
+  const id = new URL(request.url).searchParams.get("id");
+  if (!id || !ObjectId.isValid(id)) {
+    return NextResponse.json({ error: "valid id is required" }, { status: 400 });
+  }
+  const col = await contacts();
+  await col.deleteOne({ _id: new ObjectId(id) });
+  return NextResponse.json({ ok: true });
+}

package/src/corpus/templates/crm/services/web/app/contact-manager.js

@@ -0,0 +1,102 @@
+"use client";
+
+// Small client component: renders the contacts table and posts to /api/contacts.
+import { useState } from "react";
+
+const STAGES = ["lead", "qualified", "customer"];
+const LABELS = { lead: "Lead", qualified: "Qualified", customer: "Customer" };
+
+export default function ContactManager({ initialContacts }) {
+  const [contacts, setContacts] = useState(initialContacts);
+  const [name, setName] = useState("");
+  const [email, setEmail] = useState("");
+  const [company, setCompany] = useState("");
+  const [busy, setBusy] = useState(false);
+
+  async function add(e) {
+    e.preventDefault();
+    const value = name.trim();
+    if (!value) return;
+    setBusy(true);
+    const res = await fetch("/api/contacts", {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ name: value, email, company }),
+    });
+    if (res.ok) {
+      const contact = await res.json();
+      setContacts((prev) => [contact, ...prev]);
+      setName("");
+      setEmail("");
+      setCompany("");
+    }
+    setBusy(false);
+  }
+
+  async function setStage(id, stage) {
+    setBusy(true);
+    const res = await fetch("/api/contacts", {
+      method: "PATCH",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ id, stage }),
+    });
+    if (res.ok) setContacts((prev) => prev.map((c) => (c.id === id ? { ...c, stage } : c)));
+    setBusy(false);
+  }
+
+  async function remove(id) {
+    setBusy(true);
+    const res = await fetch(`/api/contacts?id=${encodeURIComponent(id)}`, { method: "DELETE" });
+    if (res.ok) setContacts((prev) => prev.filter((c) => c.id !== id));
+    setBusy(false);
+  }
+
+  return (
+    <div>
+      <form onSubmit={add} className="row">
+        <input value={name} onChange={(e) => setName(e.target.value)} placeholder="Name" aria-label="Name" />
+        <input value={email} onChange={(e) => setEmail(e.target.value)} placeholder="Email" aria-label="Email" />
+        <input value={company} onChange={(e) => setCompany(e.target.value)} placeholder="Company" aria-label="Company" />
+        <button type="submit" disabled={busy}>Add</button>
+      </form>
+      <table>
+        <thead>
+          <tr>
+            <th>Name</th>
+            <th>Email</th>
+            <th>Company</th>
+            <th>Stage</th>
+            <th></th>
+          </tr>
+        </thead>
+        <tbody>
+          {contacts.length === 0 && (
+            <tr><td className="empty" colSpan={5}>No contacts yet.</td></tr>
+          )}
+          {contacts.map((c) => (
+            <tr key={c.id}>
+              <td>{c.name}</td>
+              <td>{c.email}</td>
+              <td>{c.company}</td>
+              <td>
+                <select
+                  value={c.stage}
+                  onChange={(e) => setStage(c.id, e.target.value)}
+                  disabled={busy}
+                  aria-label="Stage"
+                >
+                  {STAGES.map((s) => (
+                    <option key={s} value={s}>{LABELS[s]}</option>
+                  ))}
+                </select>
+              </td>
+              <td>
+                <button type="button" onClick={() => remove(c.id)} disabled={busy}>Delete</button>
+              </td>
+            </tr>
+          ))}
+        </tbody>
+      </table>
+    </div>
+  );
+}

package/src/corpus/templates/crm/services/web/app/layout.js

@@ -0,0 +1,35 @@
+// Root layout + plain inline CSS (no external CDNs, fonts, or stylesheets).
+export const metadata = {
+  title: "CRM",
+  description: "A persistent contact CRM on CloudGrid, backed by grid-shared Mongo.",
+};
+
+const css = `
+  :root { color-scheme: light dark; }
+  * { box-sizing: border-box; }
+  body { margin: 0; font-family: system-ui, -apple-system, sans-serif; line-height: 1.5; }
+  main { max-width: 60rem; margin: 3rem auto; padding: 0 1.25rem; }
+  h1 { margin: 0 0 .25rem; }
+  .hint { margin: 0 0 1.5rem; opacity: .7; font-size: .9rem; }
+  .row { display: flex; flex-wrap: wrap; gap: .5rem; margin-bottom: 1.5rem; }
+  input, select { padding: .5rem .75rem; border: 1px solid #8886; border-radius: .5rem; font: inherit; }
+  input { flex: 1; min-width: 8rem; }
+  button { padding: .5rem .9rem; border: 1px solid #8886; border-radius: .5rem; background: #6663; font: inherit; cursor: pointer; }
+  button:disabled { opacity: .5; cursor: default; }
+  table { width: 100%; border-collapse: collapse; }
+  th, td { text-align: left; padding: .6rem .5rem; border-bottom: 1px solid #8883; vertical-align: top; }
+  th { font-size: .8rem; text-transform: uppercase; letter-spacing: .03em; opacity: .7; }
+  .stage { font-size: .8rem; padding: .15rem .5rem; border: 1px solid #8886; border-radius: 1rem; }
+  .empty { opacity: .6; }
+`;
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <head>
+        <style dangerouslySetInnerHTML={{ __html: css }} />
+      </head>
+      <body>{children}</body>
+    </html>
+  );
+}

package/src/corpus/templates/crm/services/web/app/page.js

@@ -0,0 +1,34 @@
+// Home page: a server component reads the contacts straight from Mongo, and a
+// small client component adds / restages / removes them via the API route. Data
+// persists across refresh and across users because it lives in the grid-shared
+// Mongo, not in memory.
+import { getDb } from "../lib/db.js";
+import ContactManager from "./contact-manager.js";
+
+export const dynamic = "force-dynamic";
+
+const STAGES = ["lead", "qualified", "customer"];
+
+async function listContacts() {
+  const db = await getDb();
+  const items = await db.collection("contacts").find({}).sort({ createdAt: -1 }).toArray();
+  return items.map((c) => ({
+    id: c._id.toString(),
+    name: c.name || "",
+    email: c.email || "",
+    company: c.company || "",
+    stage: STAGES.includes(c.stage) ? c.stage : "lead",
+    note: c.note || "",
+  }));
+}
+
+export default async function Page() {
+  const contacts = await listContacts();
+  return (
+    <main>
+      <h1>Contacts</h1>
+      <p className="hint">Persisted in the grid-shared Mongo — survives refresh.</p>
+      <ContactManager initialContacts={contacts} />
+    </main>
+  );
+}

package/src/corpus/templates/crm/services/web/lib/db.js

@@ -0,0 +1,32 @@
+// Cached MongoDB client for the App Router.
+//
+// The grid injects the connection string as the DATABASE_MONGODB_URL environment
+// variable (plus the legacy MONGODB_URL alias) at dev-time (`grid dev`) and
+// runtime (after `grid plug`). Read the canonical var first, fall back to the
+// legacy alias. Never hardcode a connection string here and never commit a secret.
+//
+// The env var and client are resolved LAZILY (inside getDb), never at module top
+// level — otherwise `next build` throws when it imports this module for route
+// analysis, before the grid injects the var.
+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 is not set. The grid injects it automatically — run " +
+        "this app with `grid dev` locally, or deploy it with `grid plug` (the grid " +
+        "injects the DB connection string at runtime). Do not set it by hand.",
+    );
+  }
+  if (!globalThis.__mongoClientPromise) {
+    globalThis.__mongoClientPromise = new MongoClient(uri).connect();
+  }
+  return globalThis.__mongoClientPromise;
+}
+
+export async function getDb() {
+  const client = await clientPromise();
+  // The default DB comes from the connection-string path segment the grid injects.
+  return client.db();
+}

package/src/corpus/templates/crm/services/web/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "my-crm",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "next": "^15.1.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "mongodb": "^6.12.0"
+  }
+}