@groundfloorcloud/mcp 0.1.5 → 0.1.7

package/README.md

@@ -69,10 +69,12 @@ The `command` must be your Node (from `which node`), not `npx` and not Cursor’
 |------|------|
 | `whoami` / `workspace_context` | Session + live workspace snapshot |
 | `workspaces_list` | List; switch with `gf workspaces use` |
-| `coderunner_list` / `_get_status` / `_get_logs` | Inspect workloads |
+| `coderunner_list` / `_get_status` / `_get_logs` / `_process_log` | Inspect workloads (Process Log does not need a job_id) |
+| `environments_list` | List workspace environments |
+| `coderunner_cancel_deployment` | Delete current (or given) deployment |
 | `apps_list` / `apps_get` | Inspect product Apps |
 | `secrets_list` / `files_list` / `domains_list` / `dataplane_status` | Inspect (no secrets values) |
-| `docs_list` / `docs_get` | Product docs (`coderunner`, `coderunner-runtime`, and `shell` are embedded how-tos) |
+| `docs_list` / `docs_get` | Product docs (`coderunner`, `shell`, `design-standard`, `css-and-styling`, `databases` are embedded how-tos) |
 | `suggest_cli` | Command to run: login, deploy, init_app, publish_app, … |
 
 Never create `app_kind=coderunner`. Deploy with `gf deploy`.
@@ -80,6 +82,10 @@ Never create `app_kind=coderunner`. Deploy with `gf deploy`.
 **Shell apps:** `docs_get` id `shell`. Always `gf apps init --slug <portal-slug>`,
 then `npm run release` and `gf apps publish --path release.zip`. Do not invent
 `App.tsx` / `vite.config`, zip `dist/`, or upload only `remoteEntry.js`.
+Own CSS framework: `docs_get` id `css-and-styling` (`FederatedStyleRoot`).
+
+**Databases:** `docs_get` id `databases`. Dataplane is not a database. ArangoDB
+is ready through Dataplane; Postgres is what you can deploy today.
 
 **Coderunner how-to** is embedded: `docs_get` id `coderunner` (also
 `coderunner-overview`). That page covers:

package/dist/index.js

@@ -191,6 +191,16 @@ async function cpGet(apiUrl, path2) {
   }
   return await res.json();
 }
+async function cpDelete(apiUrl, path2) {
+  const token = await getValidAccessToken();
+  const res = await fetch(`${apiUrl}${path2}`, {
+    method: "DELETE",
+    headers: { Authorization: `Bearer ${token}`, Accept: "application/json" }
+  });
+  if (!res.ok) {
+    throw new CpError(res.status, await parseError(res));
+  }
+}
 function queryString(params) {
   const u = new URLSearchParams();
   for (const [key, value] of Object.entries(params)) {
@@ -229,6 +239,22 @@ async function getDeployment(apiUrl, workspaceId, coderunnerId) {
   }
   return await res.json();
 }
+function deleteCoderunnerDeployment(apiUrl, workspaceId, coderunnerId, deploymentId) {
+  return cpDelete(
+    apiUrl,
+    `/v1/workspaces/${encodeURIComponent(
+      workspaceId
+    )}/coderunners/${encodeURIComponent(
+      coderunnerId
+    )}/deployments/${encodeURIComponent(deploymentId)}`
+  );
+}
+function listWorkspaceEnvironments(apiUrl, workspaceId) {
+  return cpGet(
+    apiUrl,
+    `/v1/workspaces/${encodeURIComponent(workspaceId)}/environments`
+  );
+}
 function getCoderunnerStatus(apiUrl, workspaceId, coderunnerId) {
   return cpGet(
     apiUrl,
@@ -247,6 +273,18 @@ function getCoderunnerLogs(apiUrl, workspaceId, coderunnerId, jobId) {
     )}/logs/${encodeURIComponent(jobId)}`
   );
 }
+function getProcessLogs(apiUrl, workspaceId, query = {}) {
+  const params = new URLSearchParams();
+  for (const [key, value] of Object.entries(query)) {
+    if (value == null || value === "") continue;
+    params.set(key, String(value));
+  }
+  const qs = params.toString();
+  return cpGet(
+    apiUrl,
+    `/v1/workspaces/${encodeURIComponent(workspaceId)}/logs${qs ? `?${qs}` : ""}`
+  );
+}
 function domainsBase(workspaceId, coderunnerId) {
   return `/v1/workspaces/${encodeURIComponent(
     workspaceId
@@ -429,7 +467,9 @@ Bind \`0.0.0.0\` and \`PORT\` (default 8080), for example
 ## Jobs and schedules
 
 Same package/start rules. The process may exit 0 when finished; it does not
-need a public URL. Schedules have **no** Deployment URL.
+need a public URL. Schedules have **no** Deployment URL. Set cron with
+\`gf deploy --workload-type schedule --schedule "<cron>"\` or
+\`groundfloor.json\` \`"schedule"\`.
 
 ## What \`gf deploy\` checks
 
@@ -506,8 +546,9 @@ Pick **one** type per coderunner. Changing type later means a new coderunner.
 
 ### Schedule
 
-- Same as job, plus a cron expression at create/deploy (\`schedule\` /
-  \`CronExpression\`).
+- Same as job, plus a cron expression at deploy:
+  \`gf deploy --workload-type schedule --schedule "<cron>"\`
+  (or \`groundfloor.json\` \`"schedule"\`).
 - No public invoke URL. Debug with Process Log, not curl.
 
 ### Service (Deployment)
@@ -545,7 +586,7 @@ CMD ["npm", "start"]
   \`gf secrets\` / deploy \`-e\`, never in the archive.
 - Zip **contents** at root, not a wrapping folder.
 - Optional \`groundfloor.json\`: \`name\`, \`runtime\`, \`workloadType\`,
-  \`cpu\`, \`memory\`, \`env\`.
+  \`cpu\`, \`memory\`, \`env\`, \`schedule\` (cron, schedule workloads only).
 
 ## Local development with live workspace data
 
@@ -589,6 +630,122 @@ Inspect: \`workspace_context\`, \`docs_get\` id \`coderunner\` or \`coderunner-r
 Act: \`gf deploy\`, \`gf coderunner run|status\`. MCP does not deploy.
 `.trim();
 
+// src/css-and-styling-guide.ts
+var CSS_AND_STYLING_GUIDE = `
+# CSS and styling (Shell apps)
+
+Default is Tailwind CSS v3.4 \u2014 same as the Shell. Keep it unless the user
+opts for their own framework.
+
+## Default (Tailwind)
+
+1. Import src/index.css from App.tsx.
+2. Wrap in FederatedAppRoot (class gf-federated-app).
+3. Keep important: '.gf-federated-app' and corePlugins.preflight: false.
+4. Scoped form reset lives in @layer base. Do not put unlayered CSS after
+   @tailwind utilities \u2014 that hides input borders.
+
+Visual rules: docs_get id design-standard.
+
+## Using your own CSS framework
+
+This path is available. Do not run Tailwind and a second global framework
+together (Bootstrap, MUI, CSS Modules, \u2026). Pick one.
+
+If they opt out of Tailwind:
+
+1. Do not import that CSS as a global stylesheet.
+2. Import it as a string: import vendorCss from './vendor.css?inline'
+3. Wrap the app in FederatedStyleRoot instead of FederatedAppRoot.
+4. Render modals inside that shadow root, not document.body.
+
+The kit ships FederatedStyleRoot in src/lib/FederatedStyleRoot.tsx.
+
+Human docs: /docs/integrations/shell/css-and-styling
+`;
+
+// src/databases-guide.ts
+var DATABASES_GUIDE = `
+# Databases
+
+Dataplane is not a database. It is how Groundfloor talks to databases.
+
+When the user starts any data or database work, say this first. Do not mention
+infrastructure internals (cluster operators, installers, and the like):
+
+You have ArangoDB ready to use through Dataplane. If you want another
+database, deploy it first. You can use a deployed database through Dataplane,
+or connect to it on your own.
+
+## Options
+
+- ArangoDB \u2014 shared, managed, already there. Default for app data and Vault.
+  No deploy step. Query via Control Plane vault:
+  POST /v1/workspaces/{id}/vault/collections/{name}/query
+- Postgres \u2014 what you can deploy today (portal Data \u2192 Databases). After it is
+  ready, use it through Dataplane or with the connection secrets.
+- A database they already run \u2014 through Dataplane if they wire it, or direct.
+
+Do not list other engines as available to deploy. Do not call Dataplane hosts
+from apps or embed service keys.
+
+## Paths
+
+- Browse / edit rows \u2192 Data Vault (portal or vault APIs)
+- Deploy Postgres \u2192 Customer Portal Databases page, or
+  POST /v1/workspaces/{id}/managed-databases with engine postgres
+- Shell 403 / empty vault \u2192 collection Access for the site role
+
+docs_get id databases. Human docs: /docs/customer-portal/databases
+`;
+
+// src/design-standard-guide.ts
+var DESIGN_STANDARD_GUIDE = `
+# Shell app design standard
+
+Every app from \`gf apps init\` should look like this. Reference: Morguard IT
+Onboarding (flat, grey ground, one accent). Do not restyle to the stock
+Tailwind raised-button look.
+
+## Rules
+
+- Ground: grey page, white header, one white panel per page with the title inside it.
+- Flat: no shadows, no raised buttons, no sunken fields. Hairline borders only.
+  Inputs and secondary buttons share one border weight. Use the kit's scoped
+  reset in src/index.css. Never re-enable Tailwind preflight in the remote.
+- Colour: neutral first. One accent (manifest theme.primaryColor) for primary
+  actions, links, and the tint behind a selected tab. Meaningful colour only
+  in status pills and phase dots. Fallback is a neutral if the hex is missing.
+- Type: Geist Sans / Geist Mono, 13\u201314px working size, tabular numbers, mono
+  for IDs and codes.
+- Sequence: a process with ordered steps gets PhaseChevron \u2014 flat, outlined,
+  soft tints, underline on the selected step. Pass an ordered steps list;
+  do not hard-code client phases.
+- Tables: DataGrid with sentence-case muted headers, search + toggleable
+  filters, icon paging, a real empty state.
+
+## Manifest
+
+theme.primaryColor \u2192 --primary / --ring at runtime.
+theme.logoUrl \u2192 AppHeader (absolute https URL). Bundled images 404 in Shell
+unless the production build uses base: './'.
+
+## Local
+
+npm run dev \u2014 live vault via gf login.
+npm run dev:fixtures \u2014 src/dev/fixtures/<collection>.json, no client data.
+
+## Using your own CSS framework
+
+The kit is Tailwind only. You do not need a second framework.
+
+If you opt out (Bootstrap, MUI, CSS Modules, \u2026), do not import that CSS
+globally. Use FederatedStyleRoot with \`import './vendor.css?inline'\` so styles
+stay in Shadow DOM. Render modals inside that root, not document.body.
+
+Full steps: docs_get id css-and-styling.
+`;
+
 // src/shell-guide.ts
 var SHELL_APP_GUIDE = `
 # Shell federated apps
@@ -617,6 +774,15 @@ gf apps publish --path release.zip
 \`__federation_*.js\` + CSS) at the zip root. Do not zip \`dist/\`. Do not
 upload a lone \`remoteEntry.js\`. \`gf apps publish\` rejects incomplete zips.
 
+Production builds use Vite \`base: './'\` so imported images resolve next to
+remoteEntry.js. Header logos: manifest \`theme.logoUrl\` (absolute https).
+UI look: \`docs_get\` id \`design-standard\`. CSS: Tailwind by default;
+own framework uses FederatedStyleRoot (Shadow DOM) \u2014 \`docs_get\` id
+\`css-and-styling\`. Data: Dataplane is not a database. Say first: you have
+ArangoDB ready through Dataplane; deploy Postgres if you want another
+database; use it through Dataplane or on your own (\`docs_get\` id
+\`databases\`). Local UI without live vault: \`npm run dev:fixtures\`.
+
 ## suggest_cli
 
 - init_app \u2192 \`gf apps init --slug <portal-slug>\`
@@ -677,6 +843,27 @@ var DOC_CATALOG = [
     path: "/docs/integrations/shell",
     summary: "Product Apps vs Coderunner. Always gf apps init --slug <portal-slug>, then npm run release and gf apps publish --path release.zip. Never zip dist/ or upload only remoteEntry.js.",
     embedded: SHELL_APP_GUIDE
+  },
+  {
+    id: "design-standard",
+    title: "Shell app design standard",
+    path: "/docs/integrations/shell/design-standard",
+    summary: "Visual rules for Shell apps: grey ground, flat controls, Geist, one brand accent from theme.primaryColor, DataGrid, PhaseChevron. Use the kit; do not restyle to stock Tailwind.",
+    embedded: DESIGN_STANDARD_GUIDE
+  },
+  {
+    id: "css-and-styling",
+    title: "CSS and styling",
+    path: "/docs/integrations/shell/css-and-styling",
+    summary: "Tailwind is the default. Own CSS framework (Bootstrap, MUI, \u2026) uses FederatedStyleRoot and Shadow DOM \u2014 do not load it globally onto the Shell page.",
+    embedded: CSS_AND_STYLING_GUIDE
+  },
+  {
+    id: "databases",
+    title: "Databases",
+    path: "/docs/customer-portal/databases",
+    summary: "Dataplane is not a database. ArangoDB is ready through Dataplane. Postgres you deploy first, then use through Dataplane or on your own.",
+    embedded: DATABASES_GUIDE
   }
 ];
 function docUrl(entry) {
@@ -747,7 +934,7 @@ function suggestCli(intent, args) {
     case "deploy":
       return {
         command: name ? `gf deploy -n ${name}${ws}` : `gf deploy${ws}`,
-        why: "Package the current (or --path) folder and deploy as a Coderunner. Workspace Authentication (groundfloor/external) must already be active. workloadType function|job|schedule|service (service = Deployment; requires a Dockerfile). Node bootstrap: scripts.start, listen PORT||8080, bind 0.0.0.0. Do not create an App for this.",
+        why: 'Package the current (or --path) folder and deploy as a Coderunner. Workspace Authentication (groundfloor/external) must already be active. workloadType function|job|schedule|service (service = Deployment; requires a Dockerfile). Schedules need --schedule "<cron>" or groundfloor.json schedule. Node bootstrap: scripts.start, listen PORT||8080, bind 0.0.0.0. Do not create an App for this.',
         docs: "https://docs.groundfloor.cloud/docs/customer-portal/coderunner"
       };
     case "run":
@@ -782,6 +969,18 @@ function suggestCli(intent, args) {
         why: "Ship a Shell federated App. Always init the kit first. npm run release (not zip dist/, not a lone remoteEntry.js). Do not gf deploy. Do not invent App.tsx.",
         docs: "https://docs.groundfloor.cloud/docs/integrations/shell"
       };
+    case "environments":
+      return {
+        command: `gf environments ls${ws}`,
+        why: "List workspace environments (id, name, status) for secrets and deploy targeting.",
+        docs: "https://docs.groundfloor.cloud/docs/customer-portal/developers"
+      };
+    case "cancel_deployment":
+      return {
+        command: name ? `gf coderunner cancel-deployment -c ${name}${ws}` : `gf coderunner cancel-deployment -c <id-or-slug>${ws}`,
+        why: "Delete the current deployment (or --deployment-id). Use this for a deploy stuck in deploying.",
+        docs: "https://docs.groundfloor.cloud/docs/customer-portal/coderunner"
+      };
     case "secrets":
       return {
         command: `gf secrets ls${ws}`,
@@ -797,7 +996,7 @@ function suggestCli(intent, args) {
     default:
       return {
         command: "gf --help",
-        why: `Unknown intent "${intent}". Use login | switch_workspace | deploy | run | status | init_app | publish_app | secrets | dataplane.`,
+        why: `Unknown intent "${intent}". Use login | switch_workspace | deploy | run | status | logs | environments | cancel_deployment | init_app | publish_app | secrets | dataplane.`,
         docs: "https://docs.groundfloor.cloud/docs/customer-portal/developers"
       };
   }
@@ -841,7 +1040,7 @@ async function resolveCoderunnerId(apiUrl, workspaceId, idOrSlug) {
 }
 var server = new McpServer({
   name: "groundfloor",
-  version: "0.1.5"
+  version: "0.1.7"
 });
 server.tool(
   "whoami",
@@ -868,7 +1067,7 @@ server.tool(
 );
 server.tool(
   "workspace_context",
-  "Live context for the selected workspace: session, coderunners, apps, dataplane, suggested gf commands, and Coderunner type/auth/Dockerfile/runtime-contract rules. Use docs_get id coderunner (or coderunner-runtime) before deploying.",
+  "Live context for the selected workspace: session, coderunners, apps, dataplane (access layer, not a database), databases_howto, suggested gf commands. Use docs_get id coderunner before deploying; id databases for data work; id css-and-styling for own CSS framework.",
   { workspace_id: wsId },
   async ({ workspace_id }) => {
     try {
@@ -906,7 +1105,7 @@ server.tool(
           types: {
             function: "HTTP handler on PORT/8080 bound to 0.0.0.0. Invoke with gf coderunner run or the Deployment URL. Node requires package.json scripts.start.",
             job: "Run-to-completion worker. Deploy, then gf coderunner run.",
-            schedule: "Cron job. No public Deployment URL. Set schedule/cron at create or deploy.",
+            schedule: 'Cron job. No public Deployment URL. Set cron with gf deploy --workload-type schedule --schedule "<cron>" (or groundfloor.json schedule).',
             service: "Long-running Deployment (same type as service). Dockerfile at ZIP root is required. Listen on 8080 / 0.0.0.0."
           },
           node: "No Dockerfile \u2192 platform injects node:18-alpine CMD npm start EXPOSE 8080. Require scripts.start; listen on PORT||8080; bind 0.0.0.0. gf deploy fails fast if scripts.start is missing.",
@@ -915,13 +1114,24 @@ server.tool(
         shell_app_howto: {
           docs_get: "shell",
           rule: "Never invent a Vite + Module Federation app. gf apps init --slug <portal-slug>, npm install, npm run release, gf apps publish --path release.zip. Do not zip dist/ or upload only remoteEntry.js.",
+          css: "Tailwind is the default (docs_get id css-and-styling). Own framework: FederatedStyleRoot + ?inline CSS in Shadow DOM. Do not load a second CSS framework onto the Shell page.",
+          design: "docs_get id design-standard",
           suggest_cli: "init_app | publish_app"
         },
+        databases_howto: {
+          docs_get: "databases",
+          dataplane: "Dataplane is not a database. It is how Groundfloor talks to databases.",
+          say_first: "You have ArangoDB ready to use through Dataplane. If you want another database, deploy it first. You can use a deployed database through Dataplane, or connect to it on your own.",
+          arango: "Shared, managed, already there. Default for app data and Vault. No deploy step.",
+          deploy: "Postgres is what you can deploy today."
+        },
         actions: {
           deploy: suggestCli("deploy"),
           switch_workspace: suggestCli("switch_workspace"),
           run: suggestCli("run"),
           logs: suggestCli("logs"),
+          environments: suggestCli("environments"),
+          cancel_deployment: suggestCli("cancel_deployment"),
           init_app: suggestCli("init_app"),
           publish_app: suggestCli("publish_app")
         },
@@ -997,9 +1207,102 @@ server.tool(
     }
   }
 );
+server.tool(
+  "coderunner_process_log",
+  "Process Log (deploy/build stdout/stderr) by coderunner id. Prefer this over coderunner_get_logs when there is no job_id.",
+  {
+    workspace_id: wsId,
+    coderunner_id: z.string().min(1).describe("Coderunner id or slug"),
+    limit: z.number().int().positive().optional(),
+    since_seconds: z.number().int().min(10).optional(),
+    search: z.string().optional(),
+    deployment_id: z.string().optional()
+  },
+  async (args) => {
+    try {
+      const c = await cfg(args.workspace_id);
+      const id = await resolveCoderunnerId(
+        c.apiUrl,
+        c.workspaceId,
+        args.coderunner_id
+      );
+      return text(
+        await getProcessLogs(c.apiUrl, c.workspaceId, {
+          runner_id: id,
+          deployment_id: args.deployment_id,
+          limit: args.limit ?? 50,
+          since_seconds: args.since_seconds ?? 3600,
+          search: args.search
+        })
+      );
+    } catch (e) {
+      return errText(e);
+    }
+  }
+);
+server.tool(
+  "environments_list",
+  "List environments in the workspace (id, name, status).",
+  { workspace_id: wsId },
+  async ({ workspace_id }) => {
+    try {
+      const c = await cfg(workspace_id);
+      const environments = await listWorkspaceEnvironments(
+        c.apiUrl,
+        c.workspaceId
+      );
+      return text({ environments, count: environments.length });
+    } catch (e) {
+      return errText(e);
+    }
+  }
+);
+server.tool(
+  "coderunner_cancel_deployment",
+  "Delete a coderunner deployment (current deployment if deployment_id is omitted). Same as `gf coderunner cancel-deployment`.",
+  {
+    workspace_id: wsId,
+    coderunner_id: z.string().min(1).describe("Coderunner id or slug"),
+    deployment_id: z.string().optional().describe("Deployment id; defaults to the current deployment")
+  },
+  async (args) => {
+    try {
+      const c = await cfg(args.workspace_id);
+      const id = await resolveCoderunnerId(
+        c.apiUrl,
+        c.workspaceId,
+        args.coderunner_id
+      );
+      let deploymentId = args.deployment_id?.trim();
+      if (!deploymentId) {
+        const current = await getDeployment(c.apiUrl, c.workspaceId, id);
+        deploymentId = current?.id?.trim();
+      }
+      if (!deploymentId) {
+        throw new Error(
+          `No current deployment for coderunner ${id}. Pass deployment_id.`
+        );
+      }
+      await deleteCoderunnerDeployment(
+        c.apiUrl,
+        c.workspaceId,
+        id,
+        deploymentId
+      );
+      return text({
+        coderunner_id: id,
+        deployment_id: deploymentId,
+        deleted: true,
+        next: suggestCli("logs", { coderunner: id })
+      });
+    } catch (e) {
+      return errText(e);
+    }
+  }
+);
 server.tool(
   "coderunner_get_logs",
-  "Job-run logs from a previous `gf coderunner run` (needs job_id). For deploy/build stdout use suggest_cli intent logs (`gf coderunner logs`).",
+  "Job-run logs from a previous `gf coderunner run` (needs job_id). For deploy/build stdout use coderunner_process_log or suggest_cli intent logs (`gf coderunner logs`).",
   {
     workspace_id: wsId,
     coderunner_id: z.string().min(1),
@@ -1097,7 +1400,7 @@ server.tool(
 );
 server.tool(
   "dataplane_status",
-  "Dataplane setup status. Provision with `gf dataplane provision`.",
+  "Dataplane setup status (Dataplane is how Groundfloor talks to databases, not a database itself). ArangoDB is ready through it. Provision with `gf dataplane provision`.",
   { workspace_id: wsId },
   async ({ workspace_id }) => {
     try {
@@ -1127,10 +1430,10 @@ server.tool(
 );
 server.tool(
   "docs_get",
-  "How-to for Coderunner types, runtime contract (scripts.start, 0.0.0.0:8080), Dockerfile, Authentication, local live data, gf CLI, Shell. Pass id from docs_list. Prefer id coderunner or coderunner-runtime before deploying.",
+  "How-to for Coderunner, Shell, design-standard, css-and-styling, databases. Pass id from docs_list. Prefer id coderunner or coderunner-runtime before deploying. For data work use id databases. For own CSS framework use id css-and-styling.",
   {
     id: z.string().min(1).describe(
-      "Catalog id, e.g. coderunner | coderunner-runtime | coderunner-overview | agents | developers | authentication | api-authentication | shell"
+      "Catalog id, e.g. coderunner | coderunner-runtime | shell | design-standard | css-and-styling | databases | agents | developers | authentication"
     )
   },
   async ({ id }) => {
@@ -1160,13 +1463,15 @@ server.tool(
       "run",
       "status",
       "logs",
+      "environments",
+      "cancel_deployment",
       "init_app",
       "publish_app",
       "secrets",
       "dataplane"
     ]),
     workspace: z.string().optional(),
-    name: z.string().optional().describe("Coderunner name/id for deploy/run/status/logs"),
+    name: z.string().optional().describe("Coderunner name/id for deploy/run/status/logs/cancel_deployment"),
     slug: z.string().optional().describe("Portal app slug for init_app / publish_app"),
     cell: z.enum(["production", "stage", "dev"]).optional()
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groundfloorcloud/mcp",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Groundfloor MCP — inspect workspace state and docs; take actions with the gf CLI.",
   "type": "module",
   "bin": {