@charisol/plexo-mcp 1.0.9 → 1.0.10

package/src/lmsTools.ts

@@ -0,0 +1,262 @@
+import { PlexoClient } from "./client/plexoClient.js";
+
+export const LMS_TOOL_DEFS = [
+  {
+    name: "create_funnel",
+    description: "Attaches Funnel/LMS capability to an existing root landing page (see create_landing_page / list_landing_pages for how to get one), seeding a single Welcome page. Gated by the organization's funnel slot allowance (get_funnel_addon_slots shows current usage) — fails with the slot summary if none is available.",
+    inputSchema: {
+      type: "object",
+      properties: { templateId: { type: "string", description: "An existing root landing page's template id to turn into a funnel." } },
+      required: ["templateId"],
+    },
+  },
+  {
+    name: "get_funnel",
+    description: "Fetches a funnel's settings: enabled state, signup mode (FREE/PAID), signup product, and welcome-page options.",
+    inputSchema: {
+      type: "object",
+      properties: { templateId: { type: "string", description: "The funnel's home page template id." } },
+      required: ["templateId"],
+    },
+  },
+  {
+    name: "update_funnel",
+    description: "Updates a funnel's settings. Only the fields provided are changed. Switching signupMode to PAID requires signupProductId (a DIGITAL Commerce product) to already be set or provided here.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        enabled: { type: "boolean" },
+        signupMode: { type: "string", enum: ["FREE", "PAID"] },
+        signupProductId: { type: "string", description: "A DIGITAL Commerce product id (see create_commerce_product). Pass an empty string to clear it." },
+        requireName: { type: "boolean" },
+        collectPhone: { type: "boolean" },
+        welcomeRedirectPath: { type: "string", description: "Pass an empty string to clear it." },
+      },
+      required: ["templateId"],
+    },
+  },
+  {
+    name: "delete_funnel",
+    description: "Soft-deletes a funnel (enabled:false — hidden from visitors). Pages, enrollments, and progress are kept, so re-enabling later restores everything as-is.",
+    inputSchema: {
+      type: "object",
+      properties: { templateId: { type: "string", description: "The funnel's home page template id." } },
+      required: ["templateId"],
+    },
+  },
+  {
+    name: "list_funnel_pages",
+    description: "Lists a funnel's pages in their display order.",
+    inputSchema: {
+      type: "object",
+      properties: { templateId: { type: "string", description: "The funnel's home page template id." } },
+      required: ["templateId"],
+    },
+  },
+  {
+    name: "create_funnel_page",
+    description: "Appends a new page to a funnel. Defaults to kind VIDEO and unlocks after the current last page — use update_funnel_page to customize unlockRules afterward.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        title: { type: "string", description: "Defaults to \"Page N\"." },
+        kind: { type: "string", enum: ["WELCOME", "VIDEO", "DOCUMENT", "IMAGE"], description: "Defaults to VIDEO." },
+      },
+      required: ["templateId"],
+    },
+  },
+  {
+    name: "update_funnel_page",
+    description: "Updates a funnel page's content and/or unlock rules. Only the fields provided are changed. unlockRules shape: { mode: \"ALL\", conditions: [...] } where each condition is one of PREREQUISITE_PAGES ({type,pageIds}), TIME_DRIP_RELATIVE ({type,days}), TIME_DRIP_FIXED_DATE ({type,date}), MANUAL_APPROVAL ({type}) — satisfied via approve_funnel_enrollment_page.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        pageId: { type: "string" },
+        title: { type: "string" },
+        kind: { type: "string", enum: ["WELCOME", "VIDEO", "DOCUMENT", "IMAGE"] },
+        contentMode: { type: "string", enum: ["SIMPLE", "RAW_HTML", "ADVANCED"], description: "SIMPLE/RAW_HTML both write to bodyHtml; ADVANCED is a full-builder page and isn't settable from here." },
+        bodyHtml: { type: "string", description: "Sanitized server-side. For a WELCOME page this renders as plain text, not markup." },
+        youtubeVideoId: { type: "string", description: "Empty string clears it." },
+        assetUrl: { type: "string", description: "Already-uploaded file URL (this tool can't accept raw bytes). Empty string clears it." },
+        assetFileName: { type: "string" },
+        assetMimeType: { type: "string" },
+        assetSizeBytes: { type: "number" },
+        unlockRules: { type: "object", description: "See this tool's description for the shape." },
+        visible: { type: "boolean" },
+      },
+      required: ["templateId", "pageId"],
+    },
+  },
+  {
+    name: "delete_funnel_page",
+    description: "Deletes a funnel page and closes the resulting order gap in the remaining pages.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        pageId: { type: "string" },
+      },
+      required: ["templateId", "pageId"],
+    },
+  },
+  {
+    name: "reorder_funnel_pages",
+    description: "Reorders a funnel's pages. orderedPageIds must contain exactly this funnel's current page ids, in the new order.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        orderedPageIds: { type: "array", items: { type: "string" } },
+      },
+      required: ["templateId", "orderedPageIds"],
+    },
+  },
+  {
+    name: "list_funnel_enrollments",
+    description: "Lists a funnel's learner enrollments, most recently enrolled first.",
+    inputSchema: {
+      type: "object",
+      properties: { templateId: { type: "string", description: "The funnel's home page template id." } },
+      required: ["templateId"],
+    },
+  },
+  {
+    name: "get_funnel_enrollment",
+    description: "Fetches one learner's enrollment plus their per-page progress.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        email: { type: "string" },
+      },
+      required: ["templateId", "email"],
+    },
+  },
+  {
+    name: "approve_funnel_enrollment_page",
+    description: "Marks one page as manually approved for one learner — the way a MANUAL_APPROVAL unlock condition gets satisfied (see update_funnel_page's unlockRules description). Reversible: calling it again just re-stamps the approval.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        email: { type: "string" },
+        pageId: { type: "string" },
+      },
+      required: ["templateId", "email", "pageId"],
+    },
+  },
+  {
+    name: "set_funnel_enrollment_status",
+    description: "Revokes or reactivates a learner's enrollment. Revoked takes effect immediately on their next page load (no session to separately invalidate).",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        email: { type: "string" },
+        status: { type: "string", enum: ["ACTIVE", "REVOKED"] },
+      },
+      required: ["templateId", "email", "status"],
+    },
+  },
+  {
+    name: "resend_funnel_magic_link",
+    description: "Re-sends the passwordless login email to an ACTIVE learner. Rate-limited to once per 60 seconds per learner.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        templateId: { type: "string", description: "The funnel's home page template id." },
+        email: { type: "string" },
+      },
+      required: ["templateId", "email"],
+    },
+  },
+  {
+    name: "get_funnel_addon_slots",
+    description: "Reports the organization's funnel slot usage (plan-included + purchased addon slots vs. funnels currently using one) and any active addon-slot subscriptions. Org-scoped, not per-site.",
+    inputSchema: { type: "object", properties: {} },
+  },
+];
+
+export const LMS_TOOL_NAMES = new Set(LMS_TOOL_DEFS.map((t) => t.name));
+
+export async function handleLmsToolCall(name: string, args: any, client: PlexoClient): Promise<any> {
+  const templateId = typeof args?.templateId === "string" ? args.templateId : "";
+
+  switch (name) {
+    case "create_funnel": {
+      if (!templateId) throw new Error("templateId is required.");
+      const result = await client.createFunnel(templateId);
+      return { success: true, funnel: result.funnel };
+    }
+
+    case "get_funnel":
+      return await client.getFunnel(templateId);
+
+    case "update_funnel": {
+      const { templateId: _t, ...payload } = args;
+      const result = await client.updateFunnel(templateId, payload);
+      return { success: true, funnel: result.funnel };
+    }
+
+    case "delete_funnel":
+      await client.deleteFunnel(templateId);
+      return { success: true };
+
+    case "list_funnel_pages":
+      return await client.listFunnelPages(templateId);
+
+    case "create_funnel_page": {
+      const result = await client.createFunnelPage(templateId, { title: args.title, kind: args.kind });
+      return { success: true, page: result.page };
+    }
+
+    case "update_funnel_page": {
+      if (!args.pageId) throw new Error("pageId is required.");
+      const { templateId: _t, pageId, ...payload } = args;
+      const result = await client.updateFunnelPage(templateId, pageId, payload);
+      return { success: true, page: result.page };
+    }
+
+    case "delete_funnel_page":
+      if (!args.pageId) throw new Error("pageId is required.");
+      await client.deleteFunnelPage(templateId, args.pageId);
+      return { success: true, deletedPageId: args.pageId };
+
+    case "reorder_funnel_pages": {
+      if (!Array.isArray(args.orderedPageIds) || args.orderedPageIds.length === 0) throw new Error("orderedPageIds is required.");
+      return await client.reorderFunnelPages(templateId, args.orderedPageIds);
+    }
+
+    case "list_funnel_enrollments":
+      return await client.listFunnelEnrollments(templateId);
+
+    case "get_funnel_enrollment":
+      if (!args.email) throw new Error("email is required.");
+      return await client.getFunnelEnrollment(templateId, args.email);
+
+    case "approve_funnel_enrollment_page": {
+      if (!args.email || !args.pageId) throw new Error("email and pageId are required.");
+      const result = await client.approveFunnelEnrollmentPage(templateId, args.email, args.pageId);
+      return { success: true, progress: result.progress };
+    }
+
+    case "set_funnel_enrollment_status": {
+      if (!args.email || !args.status) throw new Error("email and status are required.");
+      const result = await client.setFunnelEnrollmentStatus(templateId, args.email, args.status);
+      return { success: true, enrollment: result.enrollment };
+    }
+
+    case "resend_funnel_magic_link":
+      if (!args.email) throw new Error("email is required.");
+      return await client.resendFunnelMagicLink(templateId, args.email);
+
+    case "get_funnel_addon_slots":
+      return await client.getFunnelAddonSlots();
+
+    default:
+      throw new Error(`Unknown tool: ${name}`);
+  }
+}