tavant-docs-mcp 1.0.0

package/templates/cr/builders.js

@@ -0,0 +1,286 @@
+const {
+  Document, Packer, Paragraph, TextRun, HeadingLevel,
+  AlignmentType, Table, TableRow, TableCell,
+  WidthType, BorderStyle, Header, Footer,
+} = require("docx");
+const BRAND = require("../../brand");
+
+const FONT = BRAND.font;
+const ORANGE = BRAND.colors.orange;
+
+// ─── Reusable helpers ──────────────────────────────────────────────────
+function heading(text, level = HeadingLevel.HEADING_1) {
+  return new Paragraph({
+    heading: level,
+    spacing: { before: 300, after: 150 },
+    children: [
+      new TextRun({ text, bold: true, font: FONT, size: level === HeadingLevel.HEADING_1 ? 28 : 24, color: ORANGE }),
+    ],
+  });
+}
+
+function subheading(text) {
+  return new Paragraph({
+    spacing: { before: 200, after: 100 },
+    children: [
+      new TextRun({ text, bold: true, font: FONT, size: 22, color: "333333" }),
+    ],
+  });
+}
+
+function bodyText(text, options = {}) {
+  return new Paragraph({
+    spacing: { after: 120 },
+    children: [
+      new TextRun({ text, font: FONT, size: 22, color: "333333", ...options }),
+    ],
+  });
+}
+
+function bulletItem(text) {
+  return new Paragraph({
+    bullet: { level: 0 },
+    spacing: { after: 80 },
+    children: [
+      new TextRun({ text, font: FONT, size: 22, color: "333333" }),
+    ],
+  });
+}
+
+function emptyLine() {
+  return new Paragraph({ spacing: { after: 100 }, children: [] });
+}
+
+// Simple 2-column table for key-value pairs
+function kvTable(rows) {
+  const border = { style: BorderStyle.SINGLE, size: 1, color: "CCCCCC" };
+  const borders = { top: border, bottom: border, left: border, right: border };
+  return new Table({
+    width: { size: 100, type: WidthType.PERCENTAGE },
+    rows: rows.map(([label, value]) =>
+      new TableRow({
+        children: [
+          new TableCell({
+            width: { size: 40, type: WidthType.PERCENTAGE },
+            borders,
+            children: [new Paragraph({
+              spacing: { before: 40, after: 40 },
+              children: [new TextRun({ text: label, font: FONT, size: 22, bold: true, color: "333333" })],
+            })],
+          }),
+          new TableCell({
+            width: { size: 60, type: WidthType.PERCENTAGE },
+            borders,
+            children: [new Paragraph({
+              spacing: { before: 40, after: 40 },
+              children: [new TextRun({ text: value || "", font: FONT, size: 22, color: "333333" })],
+            })],
+          }),
+        ],
+      })
+    ),
+  });
+}
+
+// ─── Section builders ──────────────────────────────────────────────────
+const sectionBuilders = {
+  cover_page(data) {
+    return [
+      emptyLine(), emptyLine(), emptyLine(),
+      new Paragraph({
+        alignment: AlignmentType.CENTER,
+        spacing: { after: 200 },
+        children: [
+          new TextRun({ text: BRAND.company.toUpperCase(), bold: true, font: FONT, size: 48, color: ORANGE }),
+        ],
+      }),
+      emptyLine(),
+      new Paragraph({
+        alignment: AlignmentType.CENTER,
+        spacing: { after: 100 },
+        children: [
+          new TextRun({ text: "CHANGE REQUEST FORM", bold: true, font: FONT, size: 36, color: "333333" }),
+        ],
+      }),
+      emptyLine(),
+      new Paragraph({
+        alignment: AlignmentType.CENTER,
+        spacing: { after: 80 },
+        children: [
+          new TextRun({ text: data.customer_name || "[Customer Name]", font: FONT, size: 28, color: "666666" }),
+        ],
+      }),
+      new Paragraph({
+        alignment: AlignmentType.CENTER,
+        spacing: { after: 80 },
+        children: [
+          new TextRun({ text: data.project_name || "[Project Name]", font: FONT, size: 24, color: "666666" }),
+        ],
+      }),
+      new Paragraph({
+        alignment: AlignmentType.CENTER,
+        spacing: { after: 80 },
+        children: [
+          new TextRun({ text: data.date || "[Date]", font: FONT, size: 22, color: "666666", italics: true }),
+        ],
+      }),
+      emptyLine(),
+      new Paragraph({
+        alignment: AlignmentType.CENTER,
+        children: [
+          new TextRun({ text: "3945 Freedom Circle, Suite 600, Santa Clara, CA 95054", font: FONT, size: 18, color: "999999" }),
+        ],
+      }),
+      emptyLine(),
+      new Paragraph({
+        alignment: AlignmentType.CENTER,
+        children: [
+          new TextRun({ text: BRAND.footer, font: FONT, size: 18, color: "999999", italics: true }),
+        ],
+      }),
+    ];
+  },
+
+  background(data) {
+    const coNum = data.co_number || "001";
+    return [
+      heading(`CHANGE CONTROL CO# ${coNum}`, HeadingLevel.HEADING_2),
+      heading("1. Background"),
+      bodyText(
+        `This Change Order CO# ${coNum}, effective as of ${data.co_effective_date || "[Date]"}, is issued pursuant to that certain Statement of Work titled "${data.project_name || "[Project Name]"}" (the "SOW") entered into between ${data.customer_name || "[Customer Name]"} (hereinafter referred to as "Client" or "Customer") and Tavant Technologies, Inc. ("Tavant").`
+      ),
+      emptyLine(),
+      bodyText(
+        `The SOW was entered into on ${data.sow_date || "[SOW Date]"} under the Master Services Agreement ("MSA") dated ${data.msa_date || "[MSA Date]"} between the parties.`
+      ),
+      emptyLine(),
+      bodyText(
+        `This Change Order extends/modifies the SOW with a new end date of ${data.extended_end_date || "[Date]"}.`
+      ),
+    ];
+  },
+
+  project_details(data) {
+    const coNum = data.co_number || "001";
+    const paras = [
+      heading("2. Project Details"),
+      kvTable([
+        ["Original SOW Name", data.project_name || "[Project Name]"],
+        ["Change Order Number", `CO# ${coNum}`],
+        ["Change Order Name", data.co_name || ""],
+        ["Change Order Effective Date", data.co_effective_date || ""],
+        ["Source", data.source || "Tavant"],
+      ]),
+      emptyLine(),
+    ];
+
+    // Timeline
+    if (data.timeline_description) {
+      paras.push(subheading("Timeline"));
+      paras.push(bodyText(data.timeline_description));
+      paras.push(emptyLine());
+    }
+
+    // In Scope
+    if (data.in_scope) {
+      paras.push(subheading("Additional In Scope Services"));
+      const items = Array.isArray(data.in_scope) ? data.in_scope : [data.in_scope];
+      items.forEach(item => {
+        if (typeof item === "object" && item.category) {
+          paras.push(bodyText(item.category, { bold: true }));
+          if (item.items && Array.isArray(item.items)) {
+            item.items.forEach(sub => paras.push(bulletItem(sub)));
+          }
+        } else {
+          paras.push(bulletItem(String(item)));
+        }
+      });
+      paras.push(emptyLine());
+    }
+
+    // Out of Scope
+    if (data.out_of_scope) {
+      paras.push(subheading("Out of Scope"));
+      const items = Array.isArray(data.out_of_scope) ? data.out_of_scope : [data.out_of_scope];
+      items.forEach(item => paras.push(bulletItem(String(item))));
+      paras.push(emptyLine());
+    }
+
+    // Assumptions
+    if (data.assumptions) {
+      paras.push(subheading("Assumptions"));
+      const items = Array.isArray(data.assumptions) ? data.assumptions : [data.assumptions];
+      items.forEach(item => paras.push(bulletItem(String(item))));
+      paras.push(emptyLine());
+    }
+
+    return paras;
+  },
+
+  charges(data) {
+    return [
+      heading("3. Charges"),
+      kvTable([
+        ["Additional costs for the Change Order", data.additional_cost || "$[Amount]"],
+        ["Completion Date adjustments", data.completion_date || "[Date]"],
+      ]),
+    ];
+  },
+
+  invoicing(data) {
+    const paras = [
+      heading("4. Invoicing Details and Billing Address"),
+    ];
+    if (data.invoice_terms) {
+      const terms = Array.isArray(data.invoice_terms) ? data.invoice_terms : [data.invoice_terms];
+      terms.forEach(t => paras.push(bulletItem(String(t))));
+    } else {
+      paras.push(bulletItem("Invoices shall be submitted upon completion of deliverables."));
+      paras.push(bulletItem("All amounts are exclusive of applicable taxes."));
+    }
+    paras.push(emptyLine());
+    paras.push(bodyText(`Bill to Address: ${data.bill_to_address || "[Address]"}`));
+    return paras;
+  },
+
+  sow_reference(data) {
+    const sections = data.sow_sections || "Sections 8, 10 and 11";
+    return [
+      heading("5. SOW Cross-Reference"),
+      bodyText(`${sections} of the SOW are herein adopted in this Change Request.`),
+    ];
+  },
+
+  counterparts() {
+    return [
+      heading("6. Counterparts"),
+      bodyText(
+        `This Change Request may be executed in any number of counterparts, each of which when so executed and delivered shall be deemed an original, and such counterparts together shall constitute one and the same instrument.`
+      ),
+      emptyLine(),
+      bodyText(
+        `IN WITNESS WHEREOF, the parties hereto have caused this Change Request to be executed by their respective duly authorized representatives as of the date first written above.`
+      ),
+    ];
+  },
+
+  signatures(data) {
+    return [
+      heading("SIGNATURES"),
+      emptyLine(),
+      bodyText("TAVANT TECHNOLOGIES, INC.", { bold: true }),
+      emptyLine(),
+      bodyText("By: _________________________________"),
+      bodyText(`Title: ${data.tavant_title || "________________________"}`),
+      bodyText("Date: ___/___/______"),
+      emptyLine(), emptyLine(),
+      bodyText(data.customer_name || "[CUSTOMER NAME]", { bold: true }),
+      emptyLine(),
+      bodyText("By: _________________________________"),
+      bodyText(`Title: ${data.customer_title || "________________________"}`),
+      bodyText("Date: ___/___/______"),
+    ];
+  },
+};
+
+module.exports = sectionBuilders;

package/templates/cr/register.js

@@ -0,0 +1,189 @@
+const { Document, Packer, Header, Footer, Paragraph, TextRun, AlignmentType } = require("docx");
+const { z } = require("zod");
+const { v4: uuidv4 } = require("uuid");
+const path = require("path");
+const fs = require("fs");
+const SECTIONS = require("./sections");
+const sectionBuilders = require("./builders");
+const BRAND = require("../../brand");
+
+const changeRequests = new Map();
+
+function register(server) {
+  server.tool(
+    "cr_list_sections",
+    "List all available sections for Tavant Change Request (CR) documents with their descriptions and fields",
+    {},
+    async () => ({
+      content: [{
+        type: "text",
+        text: JSON.stringify(Object.values(SECTIONS).map((s) => ({
+          id: s.id, name: s.name, description: s.description, fields: s.fields,
+        })), null, 2),
+      }],
+    })
+  );
+
+  server.tool(
+    "cr_create",
+    "Create a new Tavant Change Request document. Returns a cr_id. Use cr_add_section to build it, then cr_export to save as .docx",
+    {
+      customer_name: z.string().optional().describe("Customer/client company name"),
+      project_name: z.string().optional().describe("Project or SOW name"),
+      co_number: z.string().optional().describe("Change Order number, e.g. '001'"),
+    },
+    async ({ customer_name, project_name, co_number }) => {
+      const id = uuidv4();
+      changeRequests.set(id, {
+        customer_name: customer_name || "[Customer Name]",
+        project_name: project_name || "[Project Name]",
+        co_number: co_number || "001",
+        sections: [],
+      });
+      return {
+        content: [{
+          type: "text",
+          text: JSON.stringify({
+            cr_id: id,
+            customer_name: changeRequests.get(id).customer_name,
+            project_name: changeRequests.get(id).project_name,
+            message: "Change Request created. Use cr_add_section to add sections, then cr_export to save.",
+          }),
+        }],
+      };
+    }
+  );
+
+  server.tool(
+    "cr_add_section",
+    "Add a section to a Change Request document",
+    {
+      cr_id: z.string().describe("The CR ID from cr_create"),
+      section: z.string().describe(
+        "Section ID: cover_page, background, project_details, charges, invoicing, sow_reference, counterparts, signatures"
+      ),
+      data: z.record(z.any()).optional().describe(
+        "Section content data. Use cr_list_sections to see fields per section."
+      ),
+    },
+    async ({ cr_id, section, data }) => {
+      const cr = changeRequests.get(cr_id);
+      if (!cr) return { content: [{ type: "text", text: "Error: Change Request not found." }], isError: true };
+      const builder = sectionBuilders[section];
+      if (!builder) {
+        return {
+          content: [{ type: "text", text: `Error: Unknown section "${section}". Available: ${Object.keys(SECTIONS).join(", ")}` }],
+          isError: true,
+        };
+      }
+      cr.sections.push({ section, data: data || {} });
+      return {
+        content: [{
+          type: "text",
+          text: JSON.stringify({ message: `Section added: ${section}`, total_sections: cr.sections.length }),
+        }],
+      };
+    }
+  );
+
+  server.tool(
+    "cr_export",
+    "Export Change Request as a .docx Word document",
+    {
+      cr_id: z.string().describe("The CR ID"),
+      output_path: z.string().optional().describe("Output file path. Defaults to ./output/CR_<project>.docx"),
+    },
+    async ({ cr_id, output_path }) => {
+      const cr = changeRequests.get(cr_id);
+      if (!cr) return { content: [{ type: "text", text: "Error: Change Request not found." }], isError: true };
+
+      const children = [];
+      for (const { section, data } of cr.sections) {
+        const builder = sectionBuilders[section];
+        if (builder) {
+          const paragraphs = builder({
+            ...data,
+            customer_name: data.customer_name || cr.customer_name,
+            project_name: data.project_name || cr.project_name,
+            co_number: data.co_number || cr.co_number,
+          });
+          children.push(...paragraphs);
+        }
+      }
+
+      const doc = new Document({
+        creator: "Tavant",
+        title: `Change Request CO# ${cr.co_number} - ${cr.project_name}`,
+        description: `Change Request for ${cr.project_name}`,
+        styles: {
+          default: {
+            document: {
+              run: { font: BRAND.font, size: 22, color: "333333" },
+            },
+          },
+        },
+        sections: [{
+          properties: {
+            page: { margin: { top: 1440, right: 1440, bottom: 1440, left: 1440 } },
+          },
+          headers: {
+            default: new Header({
+              children: [
+                new Paragraph({
+                  alignment: AlignmentType.RIGHT,
+                  children: [
+                    new TextRun({ text: BRAND.footer, font: BRAND.font, size: 16, color: "999999", italics: true }),
+                  ],
+                }),
+              ],
+            }),
+          },
+          footers: {
+            default: new Footer({
+              children: [
+                new Paragraph({
+                  alignment: AlignmentType.CENTER,
+                  children: [
+                    new TextRun({
+                      text: `CR CO# ${cr.co_number} | ${cr.project_name} | ${BRAND.company} & ${cr.customer_name} Confidential`,
+                      font: BRAND.font, size: 16, color: "999999",
+                    }),
+                  ],
+                }),
+              ],
+            }),
+          },
+          children,
+        }],
+      });
+
+      const buffer = await Packer.toBuffer(doc);
+      const sanitized = (cr.project_name || "CR").replace(/[^a-zA-Z0-9_-]/g, "_").substring(0, 50);
+      const defaultDir = path.join(process.cwd(), "output");
+      if (!fs.existsSync(defaultDir)) fs.mkdirSync(defaultDir, { recursive: true });
+      const filePath = output_path || path.join(defaultDir, `CR_${sanitized}.docx`);
+      const dir = path.dirname(filePath);
+      if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
+      fs.writeFileSync(filePath, buffer);
+
+      return {
+        content: [{
+          type: "text",
+          text: JSON.stringify({ message: "Change Request exported", file_path: filePath, total_sections: cr.sections.length }),
+        }],
+      };
+    }
+  );
+
+  server.tool(
+    "cr_delete",
+    "Delete a Change Request from memory",
+    { cr_id: z.string().describe("The CR ID") },
+    async ({ cr_id }) => {
+      if (changeRequests.delete(cr_id)) return { content: [{ type: "text", text: "Change Request deleted." }] };
+      return { content: [{ type: "text", text: "Not found." }], isError: true };
+    }
+  );
+}
+
+module.exports = { register };

package/templates/cr/sections.js

@@ -0,0 +1,55 @@
+// Change Request (CR) template section definitions — extracted from Tavant CR Template
+// 8 sections matching the real corporate Change Request form structure
+
+const SECTIONS = {
+  cover_page: {
+    id: "cover_page",
+    name: "Cover Page",
+    description: "Dark branded cover with CHANGE REQUEST FORM title, customer name, project name, date, and Tavant address",
+    fields: ["customer_name", "project_name", "date"],
+  },
+  background: {
+    id: "background",
+    name: "1. Background",
+    description: "Legal context: references the original SOW, MSA, Change Order number, parties, and dates",
+    fields: ["co_number", "project_name", "customer_name", "sow_date", "msa_date", "extended_end_date"],
+  },
+  project_details: {
+    id: "project_details",
+    name: "2. Project Details",
+    description: "Table with Original SOW Name, CO number, CO Name, CO Effective Date, Source. Plus sub-sections: Timeline, In Scope, Out of Scope, Assumptions",
+    fields: ["co_number", "co_name", "co_effective_date", "project_name", "source", "timeline_description", "in_scope", "out_of_scope", "assumptions"],
+  },
+  charges: {
+    id: "charges",
+    name: "3. Charges",
+    description: "Table with additional costs for the Change Order and completion date adjustments",
+    fields: ["additional_cost", "completion_date"],
+  },
+  invoicing: {
+    id: "invoicing",
+    name: "4. Invoicing Details & Billing",
+    description: "Invoice timing, tax exclusion note, and bill-to address",
+    fields: ["invoice_terms", "bill_to_address"],
+  },
+  sow_reference: {
+    id: "sow_reference",
+    name: "5. SOW Cross-Reference",
+    description: "Clause adopting specific SOW sections (8, 10, 11) into this Change Request",
+    fields: ["sow_sections"],
+  },
+  counterparts: {
+    id: "counterparts",
+    name: "6. Counterparts & Execution",
+    description: "Legal boilerplate: counterpart execution clause and 'In witness whereof'",
+    fields: [],
+  },
+  signatures: {
+    id: "signatures",
+    name: "Signatures",
+    description: "Side-by-side signature blocks for Tavant Technologies Inc. and Customer with By, Title, Date fields",
+    fields: ["customer_name", "customer_signatory", "customer_title", "tavant_signatory", "tavant_title"],
+  },
+};
+
+module.exports = SECTIONS;