multisite-cms-mcp 1.0.0

package/dist/tools/get-conversion-guide.js

@@ -0,0 +1,529 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConversionGuide = getConversionGuide;
+const SECTIONS = {
+    analysis: `# Phase 1: Website Analysis (MANDATORY)
+
+Before writing ANY code, complete this analysis:
+
+## 1.1 Map ALL URLs
+Visit every page and document the exact URL structure:
+\`\`\`
+/ (Homepage)
+/about or /about-us or /company
+/services or /what-we-do  
+/contact or /get-in-touch
+/blog or /news or /resources or /insights
+/blog/post-slug
+/team or /our-team
+\`\`\`
+
+## 1.2 Categorize Each Page
+
+**Page Types:**
+- **Static** - Fixed content (/, /about, /contact)
+- **List** - Shows multiple items (/blog, /team)
+- **Detail** - Single item from a list (/blog/my-post)
+
+## 1.3 Map Content Semantically
+
+Match by CONTENT TYPE, not by what the site calls it:
+
+- Time-stamped articles with authors → **Blog Posts**
+  (even if called "Insights", "News", "Resources", "Articles")
+  
+- Staff/employee profiles → **Team**
+  (even if called "Leadership", "Our People", "About Us")
+  
+- Downloadable files → **Downloads**
+  (even if called "Resources", "Library", "Documents")
+  
+- Content writers → **Authors**
+  (people credited on articles)
+
+## 1.4 Document Assets
+
+List all asset locations:
+\`\`\`
+CSS: /css/*.css, /styles/*.css
+JS: /js/*.js, /scripts/*.js  
+Images: /images/*, /assets/img/*
+Fonts: Google Fonts links, /fonts/*
+\`\`\`
+
+## 1.5 Critical Rule
+
+**PRESERVE ORIGINAL URLs**
+
+If the site uses \`/resources\` for articles, keep \`/resources\`.
+Do NOT change it to \`/blog\`.
+
+Use the manifest's path configuration to maintain original URLs.`,
+    structure: `# Package Structure
+
+Create a ZIP file with this exact structure:
+
+\`\`\`
+website-package.zip
+├── manifest.json          # Required: Defines pages and CMS templates
+├── public/                # Static assets (CSS, JS, images, fonts)
+│   ├── css/
+│   │   └── style.css
+│   ├── js/
+│   │   └── main.js
+│   └── images/
+│       └── logo.png
+├── pages/                 # HTML pages (static content)
+│   ├── index.html
+│   ├── about.html
+│   └── contact.html
+└── templates/             # CMS templates (dynamic content)
+    ├── blog_index.html
+    ├── blog_post.html
+    ├── team.html
+    └── downloads.html
+\`\`\`
+
+## Folder Rules
+
+### public/
+- ALL assets go here (CSS, JS, images, fonts)
+- Maintains subfolder structure
+- Referenced as \`/public/...\` in HTML
+
+### pages/
+- Static HTML pages
+- One file per page
+- Use data-edit-key for editable text
+
+### templates/
+- CMS-powered pages
+- Use {{tokens}} for dynamic content
+- Named by collection type`,
+    manifest: `# manifest.json Configuration
+
+## Basic Structure
+
+\`\`\`json
+{
+  "pages": [
+    {
+      "path": "/",
+      "file": "pages/index.html",
+      "title": "Home",
+      "editable": true
+    }
+  ],
+  "cmsTemplates": {
+    "blogIndex": "templates/blog_index.html",
+    "blogIndexPath": "/blog",
+    "blogPost": "templates/blog_post.html",
+    "blogPostPath": "/blog",
+    "team": "templates/team.html",
+    "teamPath": "/team",
+    "downloads": "templates/downloads.html",
+    "downloadsPath": "/downloads"
+  },
+  "defaultHeadHtml": "<!-- fonts, meta tags -->"
+}
+\`\`\`
+
+## Page Configuration
+
+Each page needs:
+- \`path\` - The URL (must start with /)
+- \`file\` - Path to HTML file in pages/
+- \`title\` - Page title for CMS
+- \`editable\` - Enable inline editing (optional)
+
+## CMS Template Paths
+
+**Path properties control URL routing:**
+
+- \`blogIndexPath: "/resources"\` → Blog listing at /resources
+- \`blogPostPath: "/resources"\` → Posts at /resources/post-slug
+- \`teamPath: "/about/team"\` → Team at /about/team
+- \`downloadsPath: "/library"\` → Downloads at /library
+
+**IMPORTANT:** Match paths to the original site's URLs!
+
+## Custom Collection Paths
+
+For dynamic collections beyond the built-ins:
+
+\`\`\`json
+{
+  "cmsTemplates": {
+    "collectionPaths": {
+      "products": "/shop",
+      "case-studies": "/work"
+    }
+  }
+}
+\`\`\``,
+    templates: `# Template Creation Guide
+
+## Template Types
+
+1. **Index Templates** - List pages (blog_index.html)
+2. **Detail Templates** - Single item pages (blog_post.html)
+3. **Static Pages** - Fixed content with data-edit-key
+
+## Index Template Pattern
+
+\`\`\`html
+<main class="blog-page">
+  <h1 data-edit-key="blog-title">Blog</h1>
+  
+  <div class="posts-grid">
+    {{#each blogs limit=12}}
+    <article class="post-card">
+      {{#if thumbnailImage}}
+        <img src="{{thumbnailImage}}" alt="{{name}}">
+      {{/if}}
+      <h2><a href="{{url}}">{{name}}</a></h2>
+      <p>{{postSummary}}</p>
+      {{#if author}}
+        <span>By {{author.name}}</span>
+      {{/if}}
+    </article>
+    {{/each}}
+  </div>
+</main>
+\`\`\`
+
+## Detail Template Pattern
+
+\`\`\`html
+<article class="blog-post">
+  {{#if mainImage}}
+    <img src="{{mainImage}}" alt="{{name}}">
+  {{/if}}
+  
+  <h1>{{name}}</h1>
+  
+  {{#if author}}
+    <div class="author">
+      By <a href="{{author.url}}">{{author.name}}</a>
+    </div>
+  {{/if}}
+  
+  <div class="content">
+    {{{postBody}}}
+  </div>
+</article>
+\`\`\`
+
+## Static Page Pattern
+
+\`\`\`html
+<main class="about-page">
+  <h1 data-edit-key="about-title">About Us</h1>
+  <p data-edit-key="about-intro">Introduction text...</p>
+  
+  <section>
+    <h2 data-edit-key="about-mission-title">Our Mission</h2>
+    <p data-edit-key="about-mission-text">Mission statement...</p>
+  </section>
+</main>
+\`\`\`
+
+## Template Must-Haves
+
+✓ Include complete header (copy from source)
+✓ Include complete footer (copy from source)
+✓ All asset paths use /public/
+✓ Rich text fields use {{{triple braces}}}`,
+    tokens: `# Token Reference
+
+## Double Braces {{...}} - Escaped Output
+Use for text, URLs, images:
+\`\`\`html
+{{name}}
+{{mainImage}}
+{{url}}
+{{author.name}}
+\`\`\`
+
+## Triple Braces {{{...}}} - Raw HTML
+Use for rich text content:
+\`\`\`html
+{{{postBody}}}
+{{{bio}}}
+{{{author.bio}}}
+\`\`\`
+
+**CRITICAL:** If a field contains HTML, you MUST use triple braces!
+
+## Loop Syntax
+\`\`\`html
+{{#each blogs}}
+  ...content for each item...
+{{/each}}
+\`\`\`
+
+**Modifiers:**
+- \`limit=N\` - Maximum items
+- \`featured=true\` - Only featured
+- \`sort="field"\` - Sort by field
+- \`order="asc|desc"\` - Sort direction
+
+## Conditionals
+\`\`\`html
+{{#if fieldName}}
+  ...show if truthy...
+{{else}}
+  ...show if falsy...
+{{/if}}
+
+{{#unless fieldName}}
+  ...show if falsy...
+{{/unless}}
+\`\`\`
+
+## Loop Variables
+Inside {{#each}}:
+- \`{{@first}}\` - true for first item
+- \`{{@last}}\` - true for last item  
+- \`{{@index}}\` - zero-based index
+
+## Collection Fields
+
+**Blog Posts:**
+- {{name}}, {{slug}}, {{url}}
+- {{mainImage}}, {{thumbnailImage}}
+- {{postSummary}}, {{{postBody}}}
+- {{featured}}, {{publishedAt}}
+- {{author.name}}, {{author.picture}}, {{{author.bio}}}
+
+**Authors:**
+- {{name}}, {{slug}}, {{url}}
+- {{picture}}, {{{bio}}}
+- {{email}}, {{twitterProfileLink}}, {{linkedinProfileLink}}
+
+**Team:**
+- {{name}}, {{slug}}, {{role}}
+- {{photo}}, {{{bio}}}, {{email}}
+- {{order}}
+
+**Downloads:**
+- {{title}}, {{slug}}, {{description}}
+- {{fileUrl}}, {{category}}, {{order}}`,
+    forms: `# Form Handling
+
+Forms are automatically captured by the CMS.
+
+## Basic Form Setup
+
+\`\`\`html
+<form data-form-name="contact">
+  <input type="text" name="name" required>
+  <input type="email" name="email" required>
+  <textarea name="message" required></textarea>
+  <button type="submit">Send</button>
+</form>
+\`\`\`
+
+## Required Attributes
+
+- \`data-form-name="xxx"\` on the form element
+- \`name="fieldName"\` on each input
+
+## Form Handler Script
+
+Add to your JavaScript:
+
+\`\`\`javascript
+document.querySelectorAll('form[data-form-name]').forEach(form => {
+  form.addEventListener('submit', async (e) => {
+    e.preventDefault();
+    
+    const formData = new FormData(form);
+    const data = Object.fromEntries(formData);
+    
+    const response = await fetch('/api/forms/submit', {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        formName: form.dataset.formName,
+        data: data
+      })
+    });
+    
+    if (response.ok) {
+      form.reset();
+      alert('Thank you!');
+    }
+  });
+});
+\`\`\`
+
+## Naming Conventions
+
+- Contact form → \`contact\`
+- Newsletter → \`newsletter\`
+- Quote request → \`quote-request\`
+- Application → \`job-application\`
+
+## Important
+
+**Tenant context is automatic** - the system handles associating forms with the correct site.`,
+    assets: `# Asset Path Rules
+
+## The Rule
+
+**ALL asset paths must use /public/ prefix**
+
+## HTML Examples
+
+\`\`\`html
+<!-- CSS -->
+<link rel="stylesheet" href="/public/css/style.css">
+
+<!-- JavaScript -->  
+<script src="/public/js/main.js"></script>
+
+<!-- Images -->
+<img src="/public/images/logo.png" alt="Logo">
+
+<!-- Favicon -->
+<link rel="icon" href="/public/images/favicon.ico">
+\`\`\`
+
+## CSS Examples
+
+\`\`\`css
+/* Correct */
+background-image: url('/public/images/hero.jpg');
+src: url('/public/fonts/custom.woff2');
+
+/* Wrong */
+background-image: url('../images/hero.jpg');
+background-image: url('images/hero.jpg');
+\`\`\`
+
+## Conversion Table
+
+| Original | Converted |
+|----------|-----------|
+| css/style.css | /public/css/style.css |
+| ../css/style.css | /public/css/style.css |
+| ./images/logo.png | /public/images/logo.png |
+| /images/logo.png | /public/images/logo.png |
+
+## External Assets
+
+Keep external URLs unchanged:
+\`\`\`html
+<!-- These stay the same -->
+<link href="https://fonts.googleapis.com/..." rel="stylesheet">
+<script src="https://cdn.example.com/lib.js"></script>
+\`\`\``,
+    checklist: `# Pre-Submission Checklist
+
+## ✓ Structure
+- [ ] manifest.json at package root
+- [ ] Static pages in pages/ folder
+- [ ] Assets in public/ folder
+- [ ] Templates in templates/ folder
+
+## ✓ manifest.json
+- [ ] All static pages listed in pages array
+- [ ] Each page has path, file, title
+- [ ] CMS templates configured with correct paths
+- [ ] Paths match original site URLs
+
+## ✓ Assets
+- [ ] ALL CSS uses /public/ paths
+- [ ] ALL JS uses /public/ paths
+- [ ] ALL images use /public/ paths
+- [ ] CSS background-image urls updated
+- [ ] Font paths in CSS updated
+
+## ✓ Templates
+- [ ] Templates include header/footer
+- [ ] {{#each}} loops have {{/each}}
+- [ ] {{#if}} conditions have {{/if}}
+- [ ] Rich text uses {{{triple braces}}}
+- [ ] Correct field names used
+
+## ✓ Field Names
+
+**Blog Posts:**
+- ✓ {{name}} NOT {{title}}
+- ✓ {{mainImage}} NOT {{coverImage}}
+- ✓ {{postSummary}} NOT {{excerpt}}
+- ✓ {{{postBody}}} with triple braces
+
+**Team:**
+- ✓ {{photo}} NOT {{picture}}
+- ✓ {{{bio}}} with triple braces
+
+**Authors:**
+- ✓ {{picture}} NOT {{photo}}
+- ✓ {{{bio}}} with triple braces
+
+## ✓ Static Pages
+- [ ] data-edit-key on editable text
+- [ ] Keys are unique and descriptive
+- [ ] Forms have data-form-name
+
+## ✓ Final Validation
+- [ ] Run validate_manifest with manifest.json
+- [ ] Run validate_template on each template
+- [ ] Run validate_package for full check`,
+    full: '', // Will be assembled from all sections
+};
+/**
+ * Returns the conversion guide, either full or a specific section
+ */
+async function getConversionGuide(section) {
+    if (section === 'full') {
+        return `# Complete Website Conversion Guide
+
+${SECTIONS.analysis}
+
+---
+
+${SECTIONS.structure}
+
+---
+
+${SECTIONS.manifest}
+
+---
+
+${SECTIONS.templates}
+
+---
+
+${SECTIONS.tokens}
+
+---
+
+${SECTIONS.forms}
+
+---
+
+${SECTIONS.assets}
+
+---
+
+${SECTIONS.checklist}
+
+---
+
+## Need More Help?
+
+Use these MCP tools during conversion:
+
+- \`get_schema\` - Get all collection fields and tokens
+- \`get_example\` - Get code examples for specific patterns
+- \`validate_manifest\` - Check your manifest.json
+- \`validate_template\` - Check template token usage
+- \`validate_package\` - Full package validation
+
+**Validate as you work** - don't wait until the end!`;
+    }
+    return SECTIONS[section] || `Section not found: ${section}`;
+}

package/dist/tools/get-example.d.ts

@@ -0,0 +1,7 @@
+type ExampleType = 'manifest_basic' | 'manifest_custom_paths' | 'blog_index_template' | 'blog_post_template' | 'team_template' | 'downloads_template' | 'authors_template' | 'author_detail_template' | 'custom_collection_template' | 'form_handling' | 'asset_paths' | 'data_edit_keys' | 'each_loop' | 'conditional_if' | 'nested_fields' | 'featured_posts';
+/**
+ * Returns example code for a specific pattern
+ */
+export declare function getExample(exampleType: ExampleType): Promise<string>;
+export {};
+//# sourceMappingURL=get-example.d.ts.map

package/dist/tools/get-example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-example.d.ts","sourceRoot":"","sources":["../../src/tools/get-example.ts"],"names":[],"mappings":"AAAA,KAAK,WAAW,GACZ,gBAAgB,GAChB,uBAAuB,GACvB,qBAAqB,GACrB,oBAAoB,GACpB,eAAe,GACf,oBAAoB,GACpB,kBAAkB,GAClB,wBAAwB,GACxB,4BAA4B,GAC5B,eAAe,GACf,aAAa,GACb,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,gBAAgB,CAAC;AA0qBrB;;GAEG;AACH,wBAAsB,UAAU,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAE1E"}