@modyo/mcp 0.1.0

package/build/prompts/channels/releases/ManageReleases.js

@@ -0,0 +1,407 @@
+import { PromptBase } from "../../../shared/index.js";
+import { z } from "zod";
+/**
+ * Prompt for managing release workflow and publishing
+ *
+ * Guides users through:
+ * - Understanding Modyo's two-step publishing process
+ * - Getting publishable elements
+ * - Creating releases
+ * - Publishing strategies
+ * - Versioning concepts
+ *
+ * @example
+ * Input: { siteId: 123 }
+ * Output: Complete release management and publishing workflow guide
+ */
+export class ManageReleasesPrompt extends PromptBase {
+    config = {
+        name: "modyo-manage-releases",
+        description: "Complete guide for managing releases and publishing workflow in Modyo",
+        isPublic: false,
+    };
+    getParamsSchema() {
+        return z.object({
+            siteId: z.number().min(1).describe("The site ID"),
+        });
+    }
+    async generate(params) {
+        this.info(`Generating release management prompt for site ${params.siteId}`);
+        const promptText = `# Manage Releases & Publishing
+
+## Overview
+Modyo uses a **two-step publishing process** to safely deploy changes to your live site.
+
+## Context: Why Two Steps?
+
+### The Problem
+Without versioning, direct changes go live immediately:
+- ❌ No way to review changes before publish
+- ❌ Cannot bundle related changes together
+- ❌ Risk of incomplete features going live
+- ❌ No rollback capability
+
+### The Solution: Releases
+Modyo's release system provides:
+- ✅ Review changes before publishing
+- ✅ Bundle multiple elements (pages, widgets, templates)
+- ✅ Publish atomically (all or nothing)
+- ✅ Version history and rollback
+- ✅ Team collaboration and approval workflows
+
+---
+
+## Publishing States
+
+### Element States
+Every element (page, widget, template) has a publishing state:
+
+1. **Draft** (New, Unpublished)
+   - Element exists but never published
+   - Not visible on live site
+   - Shown in publishable elements list
+
+2. **Published** (Live)
+   - Currently live on site
+   - Version number assigned
+   - No unpublished changes
+
+3. **Modified** (Published with Changes)
+   - Has published version (live on site)
+   - Also has unpublished changes
+   - Shown in publishable elements list
+
+4. **Staged** (In Release, Not Published)
+   - Added to release but release not published yet
+   - Changes pending
+   - Not yet live
+
+---
+
+## Two-Step Publishing Workflow
+
+### Step 1: Get Publishable Elements
+**Purpose**: See what has unpublished changes
+
+Use \`release-get-elements-to-publish\` tool:
+
+\`\`\`
+siteId: ${params.siteId}
+\`\`\`
+
+**Response Shows**:
+\`\`\`json
+{
+  "widgets": [
+    {
+      "id": 123,
+      "name": "Hero Banner",
+      "current_version": 2,
+      "status": "modified"  // Has unpublished changes
+    }
+  ],
+  "pages": [
+    {
+      "id": 456,
+      "name": "Homepage",
+      "current_version": 5,
+      "status": "draft"  // Never published
+    }
+  ],
+  "templates": [
+    {
+      "id": 789,
+      "name": "custom-header",
+      "type": "snippet",
+      "status": "modified"
+    }
+  ]
+}
+\`\`\`
+
+**What to Look For**:
+- Elements with \`status: "draft"\` or \`status: "modified"\`
+- Elements you recently created or updated
+- Related elements that should be published together
+
+### Step 2: Create Release
+**Purpose**: Bundle elements and publish them
+
+Use \`release-create\` tool:
+
+\`\`\`
+siteId: ${params.siteId}
+elements: [123, 456, 789]  // IDs from step 1
+comment: "Launching new homepage with hero banner"
+\`\`\`
+
+**What Happens**:
+1. Modyo creates a release with your selected elements
+2. All elements published atomically
+3. New version numbers assigned
+4. Elements go live on site immediately
+5. Release recorded in version history
+
+---
+
+## Publishing Strategies
+
+### 1. Single Element Publishing
+**When**: Urgent hotfix, small change
+
+\`\`\`bash
+# Step 1: Get publishable elements
+release-get-elements-to-publish
+
+# Step 2: Publish only the specific element
+release-create
+  elements: [<single-element-id>]
+  comment: "Hotfix: corrected contact form validation"
+\`\`\`
+
+### 2. Feature Bundle Publishing
+**When**: Launching a new feature (recommended)
+
+\`\`\`bash
+# Example: New blog section
+# Publish together:
+# - Blog list page (page ID: 100)
+# - Blog detail page (page ID: 101)
+# - Blog card widget (widget ID: 50)
+# - Blog styles (template ID: 25)
+
+release-create
+  elements: [100, 101, 50, 25]
+  comment: "Launch: Blog section v1.0"
+\`\`\`
+
+**Benefits**:
+- Feature goes live completely
+- No partial/broken functionality
+- Clear version history
+- Easy rollback if needed
+
+### 3. Bulk Publishing
+**When**: Site launch, major update
+
+\`\`\`bash
+# Publish many elements at once
+release-create
+  elements: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+  comment: "Site launch v1.0"
+\`\`\`
+
+**Warning**: Test thoroughly before bulk publishing!
+
+---
+
+## Common Publishing Scenarios
+
+### Scenario 1: New Widget + Add to Page
+\`\`\`
+1. Create widget definition
+2. Add widget to page
+3. Get publishable elements
+   → Shows: widget (draft), page (modified)
+4. Create release with BOTH elements
+   → Publishes widget AND page together
+\`\`\`
+
+**Why Both**: Page references widget, so widget must be published first or together.
+
+### Scenario 2: Update Multiple Pages
+\`\`\`
+1. Update homepage
+2. Update about page
+3. Update contact page
+4. Get publishable elements
+   → Shows: 3 pages (all modified)
+5. Create release with all 3 pages
+   → Publishes all updates together
+\`\`\`
+
+### Scenario 3: Template + Pages Using It
+\`\`\`
+1. Update header snippet
+2. Pages using header automatically marked as modified
+3. Get publishable elements
+   → Shows: header snippet + affected pages
+4. Decide: Publish only header, or header + pages
+\`\`\`
+
+**Best Practice**: Publish header + pages together to ensure consistency.
+
+---
+
+## Release Comments Best Practices
+
+### ✅ Good Comments
+- "Launch: New product catalog section"
+- "Fix: Homepage hero banner alignment on mobile"
+- "Update: Contact form adds phone validation"
+- "Hotfix: Broken link in footer navigation"
+- "Feature: Add language switcher to header"
+
+### ❌ Poor Comments
+- "Updates"
+- "Changes"
+- "Fix"
+- "test"
+- (empty comment)
+
+**Why Good Comments Matter**:
+- Clear version history
+- Easy to find specific changes
+- Team communication
+- Rollback identification
+
+---
+
+## Dependencies & Order
+
+### Publishing Order Matters
+
+**Correct Order**:
+\`\`\`
+1. Templates/Snippets (used by pages/widgets)
+2. Widget Definitions (used by pages)
+3. Pages (use widgets and templates)
+\`\`\`
+
+**OR**: Publish all together in one release (recommended)
+
+### Example: Homepage Redesign
+\`\`\`
+Elements to publish:
+1. new-header snippet (template ID: 10)
+2. hero-banner widget (widget ID: 20)
+3. card-grid widget (widget ID: 21)
+4. homepage page (page ID: 30)
+
+Solution: Bundle all in one release:
+release-create
+  elements: [10, 20, 21, 30]
+  comment: "Homepage redesign v2.0"
+\`\`\`
+
+---
+
+## Troubleshooting
+
+### Problem: Element Not in Publishable List
+**Causes**:
+- Element already published (no changes)
+- Element still in draft (save first)
+- Wrong site ID
+
+**Solution**: Make a change and save, then check again
+
+### Problem: Cannot Publish Widget
+**Error**: "Widget not found" when adding to page
+
+**Solution**: Widget must be published via release BEFORE adding to page
+
+### Problem: Page Doesn't Show Changes
+**Causes**:
+- Forgot to publish
+- Browser cache
+- CDN cache delay
+
+**Solutions**:
+1. Verify page published (check publishable elements)
+2. Clear browser cache (Ctrl+Shift+R / Cmd+Shift+R)
+3. Wait 1-2 minutes for CDN propagation
+
+### Problem: Too Many Elements to Publish
+**Solution**: Use staging workflow:
+1. Publish in logical groups
+2. Test each group before publishing next
+3. Use clear comments for each release
+
+---
+
+## Advanced: Rollback Strategy
+
+Modyo keeps version history. To "rollback":
+
+1. Identify the good version number
+2. Use UI to revert to previous version
+3. Publish the reverted element
+
+**Note**: Rollback via API not yet available in MCP tools.
+
+---
+
+## Verification Checklist
+
+Before creating a release:
+- [ ] All related elements identified
+- [ ] Elements reviewed and tested in staging
+- [ ] Clear, descriptive comment prepared
+- [ ] Dependencies understood (templates → widgets → pages)
+- [ ] Team notified (if collaborative)
+
+After creating a release:
+- [ ] Changes visible on live site
+- [ ] No console errors in browser
+- [ ] All functionality works as expected
+- [ ] Mobile/responsive layout correct
+- [ ] Cross-browser testing done
+
+---
+
+## Complete Workflow Example
+
+### New Feature: Blog Section
+
+**Step 1**: Create all elements
+\`\`\`
+1. Create blog-list page (get ID: 100)
+2. Create blog-detail page (get ID: 101)
+3. Create blog-card widget (get ID: 50)
+4. Create blog-styles CSS template (get ID: 25)
+\`\`\`
+
+**Step 2**: Test in preview mode
+- Verify blog list shows entries
+- Verify blog detail pages load correctly
+- Verify styling looks good
+
+**Step 3**: Get publishable elements
+\`\`\`
+tool: release-get-elements-to-publish
+siteId: ${params.siteId}
+
+Response shows:
+- Page 100 (blog-list) - draft
+- Page 101 (blog-detail) - draft
+- Widget 50 (blog-card) - draft
+- Template 25 (blog-styles) - draft
+\`\`\`
+
+**Step 4**: Create release
+\`\`\`
+tool: release-create
+siteId: ${params.siteId}
+elements: [100, 101, 50, 25]
+comment: "Launch: Blog section v1.0 - List page, detail page, card widget, and styles"
+\`\`\`
+
+**Step 5**: Verify live
+1. Visit blog list page on live site
+2. Click through to blog detail page
+3. Check all styling and functionality
+4. Celebrate launch! 🎉
+
+---
+
+## Documentation
+- Publishing: https://docs.modyo.com/en/platform/core/key-concepts.html#versioning
+- Releases: https://docs.modyo.com/en/platform/core/key-concepts.html#releases
+- Team Review: https://docs.modyo.com/en/platform/core/key-concepts.html#team-review`;
+        return this.success(promptText);
+    }
+}
+// Export instance for registration
+export const ManageReleases = new ManageReleasesPrompt();
+//# sourceMappingURL=ManageReleases.js.map

package/build/prompts/channels/releases/ManageReleases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManageReleases.js","sourceRoot":"","sources":["../../../../src/prompts/channels/releases/ManageReleases.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,oBAAqB,SAAQ,UAExC;IACU,MAAM,GAAG;QACjB,IAAI,EAAE,uBAAuB;QAC7B,WAAW,EACT,uEAAuE;QACzE,QAAQ,EAAE,KAAK;KAChB,CAAC;IAEQ,eAAe;QACvB,OAAO,CAAC,CAAC,MAAM,CAAC;YACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAA0B;QACvC,IAAI,CAAC,IAAI,CAAC,iDAAiD,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAE5E,MAAM,UAAU,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UA2Db,MAAM,CAAC,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UA4Cb,MAAM,CAAC,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAgPb,MAAM,CAAC,MAAM;;;;;;;;;;;;UAYb,MAAM,CAAC,MAAM;;;;;;;;;;;;;;;;qFAgB8D,CAAC;QAElF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;CACF;AAED,mCAAmC;AACnC,MAAM,CAAC,MAAM,cAAc,GAAW,IAAI,oBAAoB,EAAE,CAAC"}

package/build/prompts/channels/releases/ReleasesPrompts.d.ts

@@ -0,0 +1,2 @@
+export declare const ReleasesPrompts: Prompt[];
+//# sourceMappingURL=ReleasesPrompts.d.ts.map

package/build/prompts/channels/releases/ReleasesPrompts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReleasesPrompts.d.ts","sourceRoot":"","sources":["../../../../src/prompts/channels/releases/ReleasesPrompts.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,EAAE,MAAM,EAEnC,CAAC"}

package/build/prompts/channels/releases/ReleasesPrompts.js

@@ -0,0 +1,5 @@
+import { ManageReleases } from "./ManageReleases.js";
+export const ReleasesPrompts = [
+    ManageReleases,
+];
+//# sourceMappingURL=ReleasesPrompts.js.map

package/build/prompts/channels/releases/ReleasesPrompts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReleasesPrompts.js","sourceRoot":"","sources":["../../../../src/prompts/channels/releases/ReleasesPrompts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,CAAC,MAAM,eAAe,GAAa;IACvC,cAAc;CACf,CAAC"}

package/build/prompts/channels/templates/ManageTemplates.d.ts

@@ -0,0 +1,43 @@
+import type { GetPromptResult } from "@modelcontextprotocol/sdk/types.js";
+import { PromptBase } from "../../../shared/index.js";
+import { z } from "zod";
+/**
+ * Prompt for managing site templates (snippets, layouts, CSS, JS)
+ *
+ * Guides users through understanding and working with:
+ * - Template types and their purposes
+ * - Liquid support differences
+ * - System vs custom snippets
+ * - Asset referencing
+ * - Publishing workflow
+ *
+ * @example
+ * Input: { siteId: 123, templateType: "snippet" }
+ * Output: Comprehensive template management guide
+ */
+export declare class ManageTemplatesPrompt extends PromptBase<{
+    siteId: number;
+    templateType?: "snippet" | "layout" | "css" | "js" | undefined;
+}> {
+    protected config: {
+        name: string;
+        description: string;
+        isPublic: boolean;
+    };
+    protected getParamsSchema(): z.ZodObject<{
+        siteId: z.ZodNumber;
+        templateType: z.ZodOptional<z.ZodEnum<{
+            css: "css";
+            js: "js";
+            snippet: "snippet";
+            layout: "layout";
+        }>>;
+    }, z.core.$strip>;
+    generate(params: {
+        siteId: number;
+        templateType?: "snippet" | "layout" | "css" | "js" | undefined;
+    }): Promise<GetPromptResult>;
+    private getWorkflowForType;
+}
+export declare const ManageTemplates: Prompt;
+//# sourceMappingURL=ManageTemplates.d.ts.map

package/build/prompts/channels/templates/ManageTemplates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManageTemplates.d.ts","sourceRoot":"","sources":["../../../../src/prompts/channels/templates/ManageTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;GAaG;AACH,qBAAa,qBAAsB,SAAQ,UAAU,CAAC;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC;CAChE,CAAC;IACA,SAAS,CAAC,MAAM;;;;MAKd;IAEF,SAAS,CAAC,eAAe;;;;;;;;;IAenB,QAAQ,CAAC,MAAM,EAAE;QACrB,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC;KAChE,GAAG,OAAO,CAAC,eAAe,CAAC;IAyV5B,OAAO,CAAC,kBAAkB;CAgK3B;AAGD,eAAO,MAAM,eAAe,EAAE,MAAoC,CAAC"}