@cloudgrid-io/mcp 0.13.0 → 0.14.0

package/src/corpus/templates/monitoring-dashboard/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: monitoring-dashboard
+
+# 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/monitoring-dashboard/index.md

@@ -0,0 +1,328 @@
+# Template: monitoring-dashboard (service health board, Next.js + Mongo)
+
+A real, deployable monitoring dashboard backed by grid-shared MongoDB: a
+current-status grid + recent-history table. A **check** is a health sample —
+`{ service, status (up/degraded/down), latencyMs, at }`. POST checks; the board
+derives the current status (latest check per service) and shows rolling history.
+Data survives refresh and is shared across sessions — unlike a static page.
+
+**Key rules (same proven shape as app-with-data):**
+
+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 the `DATABASE_MONGODB_URL` environment
+   variable (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 `const uri = process.env.DATABASE_MONGODB_URL; if (!uri)
+   throw` fails `next build` (the module is imported for route analysis before
+   the grid injects the var). Never hardcode a connection string; never commit a
+   secret.
+3. **Declare the datastore with `needs: { database: true }`.** This is the
+   canonical shape — the deployer provisions Mongo and injects
+   `DATABASE_MONGODB_URL` (plus the legacy `MONGODB_URL` alias). `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).
+
+Write these files into the scaffolded app folder — the app code goes under
+`services/web/` — adapt the collection/fields to the user's services, then
+`grid dev` (local) / `grid plug` (deploy, async — poll to a live URL).
+
+## 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 checks, derives status grid
+services/web/app/check-form.js          # client form + status grid + history table
+services/web/app/api/checks/route.js    # GET (list) / POST (record) / 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: monitoring-dashboard
+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), so an app reading either var works. `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.
+
+## services/web/package.json
+
+```json
+{
+  "name": "monitoring-dashboard",
+  "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"
+  }
+}
+```
+
+## services/web/lib/db.js
+
+```js
+// 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`.",
+    );
+  }
+  if (!globalThis.__mongoClientPromise) {
+    globalThis.__mongoClientPromise = new MongoClient(uri).connect();
+  }
+  return globalThis.__mongoClientPromise;
+}
+
+export async function getDb() {
+  const client = await clientPromise();
+  return client.db();
+}
+```
+
+## services/web/app/layout.js
+
+```js
+export const metadata = {
+  title: "Monitoring Dashboard",
+  description: "A service health board on CloudGrid, backed by grid-shared Mongo.",
+};
+
+const css = `
+  :root { color-scheme: light dark; }
+  body { margin: 0; font-family: system-ui, sans-serif; }
+  main { max-width: 52rem; margin: 3rem auto; padding: 0 1.25rem; }
+  .grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(11rem, 1fr)); gap: .75rem; }
+  .card { border: 1px solid #8884; border-radius: .6rem; padding: .8rem .9rem; }
+  .badge { display: inline-block; padding: .1rem .5rem; border-radius: 1rem; font-size: .75rem; font-weight: 600; }
+  .badge.up { background: #1f8f4922; color: #1f8f49; }
+  .badge.degraded { background: #b9770022; color: #b97700; }
+  .badge.down { background: #c0392b22; color: #c0392b; }
+  table { width: 100%; border-collapse: collapse; }
+  th, td { text-align: left; padding: .45rem .5rem; border-bottom: 1px solid #8883; }
+`;
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <head><style dangerouslySetInnerHTML={{ __html: css }} /></head>
+      <body>{children}</body>
+    </html>
+  );
+}
+```
+
+## services/web/app/page.js
+
+```js
+import { getDb } from "../lib/db.js";
+import CheckForm from "./check-form.js";
+
+export const dynamic = "force-dynamic";
+
+async function listChecks() {
+  const db = await getDb();
+  const items = await db.collection("checks").find({}).sort({ at: -1 }).limit(200).toArray();
+  return items.map((c) => ({
+    id: c._id.toString(),
+    service: c.service,
+    status: c.status,
+    latencyMs: c.latencyMs,
+    at: (c.at instanceof Date ? c.at : new Date(c.at)).toISOString(),
+  }));
+}
+
+function currentStatus(checks) {
+  const seen = new Map();
+  for (const c of checks) if (!seen.has(c.service)) seen.set(c.service, c);
+  return [...seen.values()].sort((a, b) => a.service.localeCompare(b.service));
+}
+
+export default async function Page() {
+  const checks = await listChecks();
+  return (
+    <main>
+      <h1>Monitoring Dashboard</h1>
+      <CheckForm initialChecks={checks} initialServices={currentStatus(checks)} />
+    </main>
+  );
+}
+```
+
+## services/web/app/check-form.js
+
+```js
+"use client";
+import { useState } from "react";
+
+const STATUSES = ["up", "degraded", "down"];
+
+function computeServices(checks) {
+  const seen = new Map();
+  for (const c of checks) if (!seen.has(c.service)) seen.set(c.service, c);
+  return [...seen.values()].sort((a, b) => a.service.localeCompare(b.service));
+}
+
+export default function CheckForm({ initialChecks, initialServices }) {
+  const [checks, setChecks] = useState(initialChecks);
+  const [services, setServices] = useState(initialServices);
+  const [service, setService] = useState("");
+  const [status, setStatus] = useState("up");
+  const [latency, setLatency] = useState("");
+
+  async function add(e) {
+    e.preventDefault();
+    const name = service.trim();
+    if (!name) return;
+    const res = await fetch("/api/checks", {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ service: name, status, latencyMs: latency === "" ? undefined : Number(latency) }),
+    });
+    if (res.ok) {
+      const next = [await res.json(), ...checks];
+      setChecks(next); setServices(computeServices(next)); setService(""); setLatency("");
+    }
+  }
+
+  return (
+    <div>
+      <form onSubmit={add} className="row">
+        <input value={service} onChange={(e) => setService(e.target.value)} placeholder="Service name…" />
+        <select value={status} onChange={(e) => setStatus(e.target.value)}>
+          {STATUSES.map((s) => <option key={s} value={s}>{s}</option>)}
+        </select>
+        <input type="number" min="0" value={latency} onChange={(e) => setLatency(e.target.value)} placeholder="Latency ms" />
+        <button type="submit">Record check</button>
+      </form>
+      <h2>Current status</h2>
+      <div className="grid">
+        {services.map((s) => (
+          <div className="card" key={s.service}>
+            <div>{s.service}</div>
+            <span className={`badge ${s.status}`}>{s.status}</span>
+          </div>
+        ))}
+      </div>
+      <h2>Recent history</h2>
+      <table>
+        <thead><tr><th>Service</th><th>Status</th><th>Latency</th><th>At</th></tr></thead>
+        <tbody>
+          {checks.map((c) => (
+            <tr key={c.id}>
+              <td>{c.service}</td>
+              <td><span className={`badge ${c.status}`}>{c.status}</span></td>
+              <td>{typeof c.latencyMs === "number" ? `${c.latencyMs} ms` : "—"}</td>
+              <td>{new Date(c.at).toLocaleString()}</td>
+            </tr>
+          ))}
+        </tbody>
+      </table>
+    </div>
+  );
+}
+```
+
+## services/web/app/api/checks/route.js
+
+```js
+import { NextResponse } from "next/server";
+import { ObjectId } from "mongodb";
+import { getDb } from "../../../lib/db.js";
+
+export const dynamic = "force-dynamic";
+
+const STATUSES = ["up", "degraded", "down"];
+
+async function checks() {
+  const db = await getDb();
+  return db.collection("checks");
+}
+
+function serialize(c) {
+  return {
+    id: c._id.toString(),
+    service: c.service,
+    status: c.status,
+    latencyMs: c.latencyMs,
+    at: (c.at instanceof Date ? c.at : new Date(c.at)).toISOString(),
+  };
+}
+
+export async function GET() {
+  const col = await checks();
+  const items = await col.find({}).sort({ at: -1 }).limit(200).toArray();
+  return NextResponse.json(items.map(serialize));
+}
+
+export async function POST(request) {
+  const body = await request.json().catch(() => ({}));
+  const service = typeof body.service === "string" ? body.service.trim() : "";
+  const status = typeof body.status === "string" ? body.status : "";
+  if (!service) return NextResponse.json({ error: "service is required" }, { status: 400 });
+  if (!STATUSES.includes(status)) {
+    return NextResponse.json({ error: `status must be one of ${STATUSES.join(", ")}` }, { status: 400 });
+  }
+  let latencyMs;
+  if (body.latencyMs !== undefined && body.latencyMs !== null && body.latencyMs !== "") {
+    const n = Number(body.latencyMs);
+    if (!Number.isFinite(n) || n < 0) {
+      return NextResponse.json({ error: "latencyMs must be a non-negative number" }, { status: 400 });
+    }
+    latencyMs = n;
+  }
+  const doc = { service, status, at: new Date() };
+  if (latencyMs !== undefined) doc.latencyMs = latencyMs;
+  const col = await checks();
+  const res = await col.insertOne(doc);
+  return NextResponse.json(serialize({ _id: res.insertedId, ...doc }), { status: 201 });
+}
+
+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 checks();
+  await col.deleteOne({ _id: new ObjectId(id) });
+  return NextResponse.json({ ok: true });
+}
+```
+
+## Adapt it
+
+- Rename the `checks` collection (`pings`, `incidents`, `samples`).
+- Change document fields; add `region`, `endpoint`, `httpStatus`.
+- Add an uptime percentage or a sparkline from the history.
+- 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/monitoring-dashboard/services/web/app/api/checks/route.js

@@ -0,0 +1,76 @@
+// App Router route handler for the `checks` collection.
+// GET  -> list recent checks, POST -> record a check, DELETE -> remove a check by id.
+//
+// A check is a health sample: { service, status(up/down/degraded), latencyMs, at }.
+// To adapt this app, rename the collection and change the fields to match your
+// own monitoring data.
+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 STATUSES = ["up", "degraded", "down"];
+
+async function checks() {
+  const db = await getDb();
+  return db.collection("checks");
+}
+
+function serialize(c) {
+  return {
+    id: c._id.toString(),
+    service: c.service,
+    status: c.status,
+    latencyMs: c.latencyMs,
+    at: (c.at instanceof Date ? c.at : new Date(c.at)).toISOString(),
+  };
+}
+
+// GET /api/checks — list recent checks, newest first.
+export async function GET() {
+  const col = await checks();
+  const items = await col.find({}).sort({ at: -1 }).limit(200).toArray();
+  return NextResponse.json(items.map(serialize));
+}
+
+// POST /api/checks — record a check. Body: { service, status, latencyMs? }.
+export async function POST(request) {
+  const body = await request.json().catch(() => ({}));
+  const service = typeof body.service === "string" ? body.service.trim() : "";
+  const status = typeof body.status === "string" ? body.status : "";
+  if (!service) {
+    return NextResponse.json({ error: "service is required" }, { status: 400 });
+  }
+  if (!STATUSES.includes(status)) {
+    return NextResponse.json(
+      { error: `status must be one of ${STATUSES.join(", ")}` },
+      { status: 400 },
+    );
+  }
+  let latencyMs;
+  if (body.latencyMs !== undefined && body.latencyMs !== null && body.latencyMs !== "") {
+    const n = Number(body.latencyMs);
+    if (!Number.isFinite(n) || n < 0) {
+      return NextResponse.json({ error: "latencyMs must be a non-negative number" }, { status: 400 });
+    }
+    latencyMs = n;
+  }
+  const doc = { service, status, at: new Date() };
+  if (latencyMs !== undefined) doc.latencyMs = latencyMs;
+  const col = await checks();
+  const res = await col.insertOne(doc);
+  return NextResponse.json(serialize({ _id: res.insertedId, ...doc }), { status: 201 });
+}
+
+// DELETE /api/checks?id=<id> — remove a check.
+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 checks();
+  await col.deleteOne({ _id: new ObjectId(id) });
+  return NextResponse.json({ ok: true });
+}