@cloudgrid-io/mcp 0.11.2 → 0.12.0

package/src/corpus/templates/ai-app/index.md

@@ -0,0 +1,269 @@
+# Template: ai-app (Next.js AI chatbot + grid AI gateway + Mongo)
+
+A minimal but real, deployable AI chatbot. A Next.js App Router app that calls
+the grid AI gateway (via `@cloudgrid-io/ai`) for replies and persists the
+conversation to the grid-shared MongoDB. History survives refresh and is shared
+across sessions.
+
+**Key rules (all proven by a real end-to-end deploy):**
+
+1. **App 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/`. Files at the root
+   fail with `Error: Service directory not found: …/services/web`.
+2. **The AI call is zero-config — no API key.** `import { createClient } from
+   "@cloudgrid-io/ai"; const client = createClient();` auto-detects the in-grid
+   identity, so it only works inside a deployed grid app (or under `grid dev`).
+   Do NOT pass or set an API key. Read the reply from `r.text` (fall back to
+   `r.content`).
+3. **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 + 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.
+4. **Declare `needs: { ai: true, database: true }`.** The deployer wires the AI
+   gateway and provisions Mongo (injecting `DATABASE_MONGODB_URL` + legacy
+   `MONGODB_URL`). `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 persona/UI, then `grid dev` (local) / `grid plug`
+(deploy, async — poll to a live URL).
+
+## File tree
+
+```
+cloudgrid.yaml                        # name + services.web (nextjs) + needs: { ai: true, database: true }
+services/web/package.json             # next, react, react-dom, @cloudgrid-io/ai, mongodb
+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 chat history from Mongo
+services/web/app/chat.js              # client component: sends messages, renders the log
+services/web/app/api/chat/route.js    # POST: createClient().chat(...) -> persist -> reply; GET: history
+```
+
+## cloudgrid.yaml
+
+```yaml
+# Rename this chatbot. The grid wires the AI gateway (in-grid identity — no API
+# key) and injects the DB connection string as an environment variable at
+# runtime. Do NOT set an AI key, do NOT set the DB var yourself, and never commit
+# a connection string or secret.
+#
+# `needs: { ai: true, database: true }` is the canonical shape. The deployer
+# wires the AI gateway and provisions Mongo, injecting 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.
+name: my-chatbot
+services:
+  web:
+    type: nextjs
+    path: /
+needs:
+  ai: true
+  database: true
+# For retrieval-augmented (RAG) over your own docs, add `needs: { vector:
+# pgvector }` once platform issue #1545 ships — not yet available.
+```
+
+> **Capability:** this template's needs are `ai: true` (the grid AI gateway,
+> in-grid identity — no key) and `database: true` (Mongo, injected as
+> `DATABASE_MONGODB_URL` + legacy `MONGODB_URL`). `requires:` is the deprecated
+> v1 alias — don't mix it with `needs:`. See the capability-map for the full
+> injection table.
+
+## services/web/package.json
+
+```json
+{
+  "name": "my-chatbot",
+  "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",
+    "@cloudgrid-io/ai": "^0.2.0",
+    "mongodb": "^6.12.0"
+  }
+}
+```
+
+## services/web/lib/db.js
+
+```js
+// Cached Mongo client for the chat history. The grid injects DATABASE_MONGODB_URL
+// (plus the legacy MONGODB_URL alias) at dev + runtime. Resolve it LAZILY inside
+// the getter — a top-level read fails `next build`. Never hardcode a connection
+// string; never commit a secret.
+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 — run `grid dev` " +
+        "locally or deploy with `grid plug`. Do not set it by hand.",
+    );
+  }
+  if (!globalThis.__mongoClientPromise) {
+    globalThis.__mongoClientPromise = new MongoClient(uri).connect();
+  }
+  return globalThis.__mongoClientPromise;
+}
+
+export async function getDb() {
+  return (await clientPromise()).db();
+}
+```
+
+## services/web/app/api/chat/route.js
+
+```js
+// Chat API route: take the user's message, ask the grid AI gateway for a reply,
+// persist the exchange to Mongo, return the reply.
+//
+// The AI call uses @cloudgrid-io/ai with ZERO config — no API key. createClient()
+// auto-detects the in-grid identity, so it only works inside a deployed grid app
+// (or under `grid dev`). Do NOT pass a key.
+import { NextResponse } from "next/server";
+import { createClient } from "@cloudgrid-io/ai";
+import { getDb } from "../../../lib/db.js";
+
+export const dynamic = "force-dynamic";
+
+async function messages() {
+  return (await getDb()).collection("messages");
+}
+
+// POST /api/chat — body { message: string }. Returns { reply: string }.
+export async function POST(request) {
+  const body = await request.json().catch(() => ({}));
+  const text = typeof body.message === "string" ? body.message.trim() : "";
+  if (!text) {
+    return NextResponse.json({ error: "message is required" }, { status: 400 });
+  }
+
+  // 1. Ask the grid AI gateway (zero-config in-grid identity — no key).
+  const client = createClient();
+  const r = await client.chat({ messages: [{ role: "user", content: text }] });
+  const reply = r.text ?? r.content ?? "";
+
+  // 2. Persist the exchange so the conversation survives refresh.
+  const col = await messages();
+  const now = new Date();
+  await col.insertMany([
+    { role: "user", content: text, createdAt: now },
+    { role: "assistant", content: reply, createdAt: new Date(now.getTime() + 1) },
+  ]);
+
+  // 3. Return the reply.
+  return NextResponse.json({ reply });
+}
+
+// GET /api/chat — the stored conversation, oldest first.
+export async function GET() {
+  const col = await messages();
+  const history = await col.find({}).sort({ createdAt: 1 }).toArray();
+  return NextResponse.json(
+    history.map((m) => ({ id: m._id.toString(), role: m.role, content: m.content })),
+  );
+}
+```
+
+## services/web/app/page.js
+
+```js
+import { getDb } from "../lib/db.js";
+import Chat from "./chat.js";
+
+export const dynamic = "force-dynamic";
+
+async function listHistory() {
+  const items = await (await getDb())
+    .collection("messages")
+    .find({})
+    .sort({ createdAt: 1 })
+    .toArray();
+  return items.map((m) => ({ id: m._id.toString(), role: m.role, content: m.content }));
+}
+
+export default async function Page() {
+  const history = await listHistory();
+  return (
+    <main>
+      <h1>AI Assistant</h1>
+      <p className="hint">Powered by the grid AI gateway — conversation persisted in Mongo.</p>
+      <Chat initialHistory={history} />
+    </main>
+  );
+}
+```
+
+## services/web/app/chat.js
+
+```js
+"use client";
+import { useState } from "react";
+
+export default function Chat({ initialHistory }) {
+  const [history, setHistory] = useState(initialHistory);
+  const [text, setText] = useState("");
+  const [busy, setBusy] = useState(false);
+
+  async function send(e) {
+    e.preventDefault();
+    const value = text.trim();
+    if (!value || busy) return;
+    setBusy(true);
+    setHistory((p) => [...p, { id: `local-${Date.now()}`, role: "user", content: value }]);
+    setText("");
+    const res = await fetch("/api/chat", {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ message: value }),
+    });
+    if (res.ok) {
+      const { reply } = await res.json();
+      setHistory((p) => [...p, { id: `local-${Date.now()}-a`, role: "assistant", content: reply }]);
+    }
+    setBusy(false);
+  }
+
+  return (
+    <div>
+      <ul className="log">
+        {history.length === 0 && <li className="empty">Say hello to start the conversation.</li>}
+        {history.map((m) => (
+          <li key={m.id} className={m.role}>
+            <span className="who">{m.role === "user" ? "You" : "Assistant"}</span>
+            <span className="msg">{m.content}</span>
+          </li>
+        ))}
+      </ul>
+      <form onSubmit={send} className="row">
+        <input value={text} onChange={(e) => setText(e.target.value)} placeholder="Ask something…" disabled={busy} />
+        <button type="submit" disabled={busy}>{busy ? "…" : "Send"}</button>
+      </form>
+    </div>
+  );
+}
+```
+
+## Adapt it
+
+- Give the assistant a persona — pass a `{ role: "system", content: "…" }`
+  message ahead of the user message in `chat({ messages })`.
+- Send prior turns as context by including the stored history in `messages`.
+- Change the `messages` collection / fields; add users, sessions, titles.
+- Run `grid dev` to test locally, `grid plug` to deploy (async — poll to live).
+
+## RAG / retrieval (not yet)
+
+To answer over **your own documents** (retrieval-augmented generation) you need a
+vector store — `needs: { vector: pgvector }`. That path is **not yet available**
+(platform issue #1545). Ship the plain chatbot now; add retrieval once the vector
+need is unblocked.

package/src/corpus/templates/ai-app/services/web/app/api/chat/route.js

@@ -0,0 +1,51 @@
+// Chat API route: takes the user's message, asks the grid AI gateway for a
+// reply, persists the exchange to Mongo, and returns the reply.
+//
+// The AI call uses @cloudgrid-io/ai with ZERO config — no API key. createClient()
+// auto-detects the in-grid identity, so it only works inside a deployed grid app
+// (or under `grid dev`). Do NOT pass a key.
+import { NextResponse } from "next/server";
+import { createClient } from "@cloudgrid-io/ai";
+import { getDb } from "../../../lib/db.js";
+
+// Never cache — always generate/persist live.
+export const dynamic = "force-dynamic";
+
+async function messages() {
+  const db = await getDb();
+  return db.collection("messages");
+}
+
+// POST /api/chat — body { message: string }. Returns { reply: string }.
+export async function POST(request) {
+  const body = await request.json().catch(() => ({}));
+  const text = typeof body.message === "string" ? body.message.trim() : "";
+  if (!text) {
+    return NextResponse.json({ error: "message is required" }, { status: 400 });
+  }
+
+  // 1. Ask the grid AI gateway (zero-config in-grid identity — no key).
+  const client = createClient();
+  const r = await client.chat({ messages: [{ role: "user", content: text }] });
+  const reply = r.text ?? r.content ?? "";
+
+  // 2. Persist the exchange so the conversation survives refresh.
+  const col = await messages();
+  const now = new Date();
+  await col.insertMany([
+    { role: "user", content: text, createdAt: now },
+    { role: "assistant", content: reply, createdAt: new Date(now.getTime() + 1) },
+  ]);
+
+  // 3. Return the reply.
+  return NextResponse.json({ reply });
+}
+
+// GET /api/chat — the stored conversation, oldest first.
+export async function GET() {
+  const col = await messages();
+  const history = await col.find({}).sort({ createdAt: 1 }).toArray();
+  return NextResponse.json(
+    history.map((m) => ({ id: m._id.toString(), role: m.role, content: m.content })),
+  );
+}

package/src/corpus/templates/ai-app/services/web/app/chat.js

@@ -0,0 +1,60 @@
+"use client";
+
+// Small client component: renders the conversation and posts new messages to
+// /api/chat. The route calls the grid AI gateway, persists the exchange, and
+// returns the reply.
+import { useState } from "react";
+
+export default function Chat({ initialHistory }) {
+  const [history, setHistory] = useState(initialHistory);
+  const [text, setText] = useState("");
+  const [busy, setBusy] = useState(false);
+
+  async function send(e) {
+    e.preventDefault();
+    const value = text.trim();
+    if (!value || busy) return;
+    setBusy(true);
+    setHistory((prev) => [...prev, { id: `local-${Date.now()}`, role: "user", content: value }]);
+    setText("");
+    const res = await fetch("/api/chat", {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ message: value }),
+    });
+    if (res.ok) {
+      const { reply } = await res.json();
+      setHistory((prev) => [...prev, { id: `local-${Date.now()}-a`, role: "assistant", content: reply }]);
+    } else {
+      setHistory((prev) => [
+        ...prev,
+        { id: `local-${Date.now()}-e`, role: "assistant", content: "Something went wrong. Try again." },
+      ]);
+    }
+    setBusy(false);
+  }
+
+  return (
+    <div>
+      <ul className="log">
+        {history.length === 0 && <li className="empty">Say hello to start the conversation.</li>}
+        {history.map((m) => (
+          <li key={m.id} className={m.role}>
+            <span className="who">{m.role === "user" ? "You" : "Assistant"}</span>
+            <span className="msg">{m.content}</span>
+          </li>
+        ))}
+      </ul>
+      <form onSubmit={send} className="row">
+        <input
+          value={text}
+          onChange={(e) => setText(e.target.value)}
+          placeholder="Ask something…"
+          aria-label="Message"
+          disabled={busy}
+        />
+        <button type="submit" disabled={busy}>{busy ? "…" : "Send"}</button>
+      </form>
+    </div>
+  );
+}

package/src/corpus/templates/ai-app/services/web/app/layout.js

@@ -0,0 +1,36 @@
+// Root layout + plain inline CSS (no external CDNs, fonts, or stylesheets).
+export const metadata = {
+  title: "AI Assistant",
+  description: "An AI chatbot on CloudGrid — grid AI gateway + 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: 42rem; margin: 3rem auto; padding: 0 1.25rem; }
+  h1 { margin: 0 0 .25rem; }
+  .hint { margin: 0 0 1.5rem; opacity: .7; font-size: .9rem; }
+  .log { list-style: none; padding: 0; margin: 0 0 1rem; display: flex; flex-direction: column; gap: .75rem; }
+  .log li { display: flex; flex-direction: column; gap: .15rem; }
+  .log li.user { align-items: flex-end; text-align: right; }
+  .log li.empty { opacity: .6; align-items: flex-start; }
+  .who { font-size: .75rem; opacity: .6; }
+  .msg { display: inline-block; padding: .5rem .75rem; border-radius: .6rem; background: #8882; max-width: 85%; white-space: pre-wrap; }
+  .log li.user .msg { background: #4a90d922; }
+  .row { display: flex; gap: .5rem; }
+  input { flex: 1; padding: .5rem .75rem; border: 1px solid #8886; border-radius: .5rem; font: inherit; }
+  button { padding: .5rem .9rem; border: 1px solid #8886; border-radius: .5rem; background: #6663; font: inherit; cursor: pointer; }
+  button:disabled { opacity: .5; cursor: default; }
+`;
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <head>
+        <style dangerouslySetInnerHTML={{ __html: css }} />
+      </head>
+      <body>{children}</body>
+    </html>
+  );
+}

package/src/corpus/templates/ai-app/services/web/app/page.js

@@ -0,0 +1,25 @@
+// Home page: a server component reads the stored conversation straight from
+// Mongo, and a small client component sends new messages via the /api/chat
+// route (which calls the grid AI gateway and persists the exchange). History
+// persists across refresh because it lives in the grid-shared Mongo.
+import { getDb } from "../lib/db.js";
+import Chat from "./chat.js";
+
+export const dynamic = "force-dynamic";
+
+async function listHistory() {
+  const db = await getDb();
+  const items = await db.collection("messages").find({}).sort({ createdAt: 1 }).toArray();
+  return items.map((m) => ({ id: m._id.toString(), role: m.role, content: m.content }));
+}
+
+export default async function Page() {
+  const history = await listHistory();
+  return (
+    <main>
+      <h1>AI Assistant</h1>
+      <p className="hint">Powered by the grid AI gateway — conversation persisted in Mongo.</p>
+      <Chat initialHistory={history} />
+    </main>
+  );
+}

package/src/corpus/templates/ai-app/services/web/lib/db.js

@@ -0,0 +1,32 @@
+// Cached MongoDB client for the App Router — stores the chat history.
+//
+// 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/ai-app/services/web/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "my-chatbot",
+  "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",
+    "@cloudgrid-io/ai": "^0.2.0",
+    "mongodb": "^6.12.0"
+  }
+}

package/src/corpus/templates/api-service/README.md

@@ -0,0 +1,87 @@
+# api-service template — REST/JSON API on Node + Mongo
+
+A minimal but real, deployable backend API. It is a plain Node `http` service
+(no web UI, no framework) that serves a small REST resource (`/items`) backed by
+the grid-shared MongoDB, so data survives refresh and is shared across sessions.
+This is the plain-service sibling of `app-with-data` — reach for it when the user
+wants a backend/API, not a full web app.
+
+## How the grid gives you a database
+
+You do **not** provision a database or set a connection string. In
+`cloudgrid.yaml` you declare `needs: { database: true }`, and the grid:
+
+- provisions shared Mongo for the service, and
+- injects the connection string as the **`DATABASE_MONGODB_URL`** environment
+  variable (plus the legacy `MONGODB_URL` alias) — at dev-time (`grid dev`) and
+  at runtime (after `grid plug`).
+
+The service reads it via `process.env.DATABASE_MONGODB_URL` (with a legacy
+`process.env.MONGODB_URL` fallback) inside `getDb` — **lazily, never at module
+top level.** A top-level read throws at node startup, before the grid injects
+the var, and crashes the service. Never hardcode a connection string; never
+commit a secret.
+
+> **Declare `needs: { database: true }` (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).
+
+## Service layout
+
+Service code lives under **`services/api/`**, not the template root. `path:` in
+`cloudgrid.yaml` is the URL mount, not the filesystem path — the service named
+`api` means the CLI looks for `services/api/`. Files at the root fail with
+`Error: Service directory not found: …/services/api`.
+
+The server listens on `process.env.PORT || 8080` — the grid injects `PORT`; the
+`8080` default is for local runs.
+
+## Run locally
+
+```bash
+cd services/api && npm install && cd -
+grid dev          # runs the service with DATABASE_MONGODB_URL injected against dev Mongo
+```
+
+Then hit it:
+
+```bash
+curl -s localhost:8080/items
+curl -s -XPOST localhost:8080/items -H 'content-type: application/json' -d '{"text":"hello"}'
+```
+
+## Deploy
+
+```bash
+grid plug         # builds + deploys the folder (async — poll status until live)
+```
+
+A runtime deploy is asynchronous: `plug` returns `status: building`; poll status
+until the service is live, then use the returned live URL. Re-plug the same
+entity to update the same URL.
+
+## File tree
+
+```
+cloudgrid.yaml                 # name + services.api (node) + needs: { database: true }
+services/api/package.json      # type: module, main src/index.js, mongodb driver only
+services/api/src/index.js      # Node http server on PORT||8080; /items GET/POST/DELETE on Mongo
+```
+
+## Endpoints
+
+| Method | Path              | Description                          |
+|--------|-------------------|--------------------------------------|
+| GET    | `/`               | service banner + endpoint list       |
+| GET    | `/items`          | list items, newest first             |
+| POST   | `/items`          | create an item; body `{ "text": … }` |
+| DELETE | `/items?id=<id>`  | remove an item by id                 |
+
+## Adapt it
+
+- Rename the `items` collection and change the document fields to your resource.
+- Add more routes/resources as the API grows.
+- Return clear JSON errors (`{ "error": … }`) with the right status codes.
+- Add more `needs:` (e.g. `cache: true`) only if you actually use them.

package/src/corpus/templates/api-service/cloudgrid.yaml

@@ -0,0 +1,18 @@
+# Rename this service. The grid injects the DB connection string as an
+# environment variable at runtime — do NOT set it yourself, and never commit a
+# connection string or secret.
+#
+# `needs: { database: true }` is the canonical, recommended 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 it).
+#
+# This is a plain Node HTTP service (type: node), not a web UI. Service code lives
+# under services/api/ — `path:` is the URL mount, not the filesystem path.
+name: my-api
+services:
+  api:
+    type: node
+    path: /
+needs:
+  database: true