salesforce-metadata-mcp 2.2.0 → 2.4.0

package/dist/tools/omnistudio.js

@@ -0,0 +1,280 @@
+import {
+    CreateFlexCardSchema, UpdateFlexCardSchema, ActivateFlexCardSchema, GetFlexCardSchema,
+    CreateOmniScriptSchema, UpdateOmniScriptSchema, ActivateOmniScriptSchema, GetOmniScriptSchema,
+    CreateDataRaptorSchema, GetDataRaptorSchema,
+    CreateIntegrationProcedureSchema, UpdateIntegrationProcedureSchema,
+    GetIntegrationProcedureSchema, ActivateIntegrationProcedureSchema,
+    CreateCalculationMatrixSchema, CreateCalculationProcedureSchema,
+} from "../schemas/index.js";
+import {
+    getAuth,
+    createFlexCard, updateFlexCard, activateFlexCard, getFlexCard,
+    createOmniScript, updateOmniScript, activateOmniScript, getOmniScript,
+    createDataRaptor, getDataRaptor,
+    createIntegrationProcedure, updateIntegrationProcedure, activateIntegrationProcedure, getIntegrationProcedure,
+    createCalculationMatrix, createCalculationProcedure,
+} from "../services/salesforce.js";
+import { resultContent } from "./utils.js";
+
+export function registerOmniStudioTools(server) {
+    // ─── FLEXCARDS ────────────────────────────────────────────────────────────
+    server.registerTool("sf_create_flexcard", {
+        title: "Create OmniStudio FlexCard",
+        description: `Creates an OmniStudio FlexCard (OmniUiCard metadata type). FlexCards display contextual data on Lightning pages and Experience Cloud sites.
+
+A FlexCard defines:
+- A data source (SOQL query, DataRaptor, Integration Procedure, Apex, or None)
+- Fields to display from the data source
+- Actions the user can take (navigate, launch OmniScript, open URL, start Flow)
+- States (card variations based on data conditions)
+
+The card is created in inactive state. Use sf_activate_flexcard to activate it after creation.
+
+dataSourceType options:
+- SOQL: provide a dataSourceName with a SOQL query string
+- DataRaptor: provide the DataRaptor interface name
+- IntegrationProcedure: provide the Integration Procedure key (Type_SubType)
+- Apex: provide the Apex class name
+- None: no data source (static card)`,
+        inputSchema: CreateFlexCardSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createFlexCard(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_update_flexcard", {
+        title: "Update OmniStudio FlexCard",
+        description: `Updates an existing OmniStudio FlexCard (OmniUiCard). Reads the current definition, merges the provided changes, and redeploys.
+
+Provide only the fields you want to change. The card will be deactivated automatically if active — use sf_activate_flexcard to reactivate after the update.
+
+All fields arrays (fields, actions, states) are replaced entirely if provided.`,
+        inputSchema: UpdateFlexCardSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await updateFlexCard(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_activate_flexcard", {
+        title: "Activate OmniStudio FlexCard",
+        description: `Activates an OmniStudio FlexCard so it is visible on Lightning pages and Experience Cloud sites.
+
+Reads the existing FlexCard definition and redeploys it with isActive=true. The card must already exist (created with sf_create_flexcard).`,
+        inputSchema: ActivateFlexCardSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await activateFlexCard(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_get_flexcard", {
+        title: "Get OmniStudio FlexCard",
+        description: `Retrieves the configuration of an OmniStudio FlexCard including its data source, fields, actions, states, and activation status.`,
+        inputSchema: GetFlexCardSchema,
+        annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await getFlexCard(auth, params);
+        return resultContent(result);
+    });
+
+    // ─── OMNISCRIPTS ──────────────────────────────────────────────────────────
+    server.registerTool("sf_create_omniscript", {
+        title: "Create OmniStudio OmniScript",
+        description: `Creates an OmniStudio OmniScript — a guided interaction flow for collecting data or performing processes.
+
+OmniScripts are identified by Type + SubType + Language (e.g. AccountOpening / Personal / English). The fullName becomes Type_SubType_Language.
+
+The script is created inactive with the specified elements. Complex element configuration (branching logic, custom LWC overrides, remote actions) should be finalized in the OmniScript Designer after creation.
+
+isLwcEnabled: true deploys the script as a Lightning Web Component (recommended for performance).
+isOmniScriptEmbeddable: true allows embedding this script inside other OmniScripts.
+
+Use sf_activate_omniscript to activate after creation.`,
+        inputSchema: CreateOmniScriptSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createOmniScript(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_update_omniscript", {
+        title: "Update OmniStudio OmniScript",
+        description: `Updates an existing OmniScript's metadata properties (description, LWC mode, embeddable flag). Identified by Type + SubType + Language.
+
+Note: OmniScript element/step editing is best done in the OmniScript Designer. This tool updates the container metadata only. The script will be deactivated if currently active — reactivate with sf_activate_omniscript.`,
+        inputSchema: UpdateOmniScriptSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await updateOmniScript(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_activate_omniscript", {
+        title: "Activate OmniStudio OmniScript",
+        description: `Activates an OmniScript so it can be launched from FlexCards, Experience Cloud, or standalone pages. Identified by Type + SubType + Language.`,
+        inputSchema: ActivateOmniScriptSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await activateOmniScript(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_get_omniscript", {
+        title: "Get OmniStudio OmniScript",
+        description: `Retrieves the configuration of an OmniScript including its elements, activation status, and LWC settings. Identified by Type + SubType + Language.`,
+        inputSchema: GetOmniScriptSchema,
+        annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await getOmniScript(auth, params);
+        return resultContent(result);
+    });
+
+    // ─── DATARAPTORS ─────────────────────────────────────────────────────────
+    server.registerTool("sf_create_dataraptor", {
+        title: "Create OmniStudio DataRaptor",
+        description: `Creates a DataRaptor interface for OmniStudio data transformation. DataRaptors handle Extract (read from Salesforce), Transform (convert data formats), and Load (write to Salesforce) operations.
+
+interfaceType:
+- Extract: reads data from Salesforce objects using SOQL-like field mappings
+- Transform: converts/maps data between formats (JSON path transformations)
+- Load: writes data to Salesforce objects
+
+Each field mapping defines:
+- sourceField: source JSON path or Salesforce field API name
+- targetField: target JSON path or Salesforce field API name
+- dataType: data type (Text, Number, Boolean, Date, etc.)
+- formula: optional transformation formula
+
+filterCriteria: SOQL WHERE clause for Extract DataRaptors (e.g. "Id = ':AccountId'")`,
+        inputSchema: CreateDataRaptorSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createDataRaptor(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_get_dataraptor", {
+        title: "Get OmniStudio DataRaptor",
+        description: `Retrieves the configuration of a DataRaptor interface including its type, field mappings, and filter criteria.`,
+        inputSchema: GetDataRaptorSchema,
+        annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await getDataRaptor(auth, params);
+        return resultContent(result);
+    });
+
+    // ─── INTEGRATION PROCEDURES ───────────────────────────────────────────────
+    server.registerTool("sf_create_integration_procedure", {
+        title: "Create OmniStudio Integration Procedure",
+        description: `Creates an OmniStudio Integration Procedure — a server-side process that orchestrates data integration without UI. Integration Procedures run in Apex context and can be invoked from OmniScripts, FlexCards, or APIs.
+
+Integration Procedures use the OmniScript metadata type with omniProcessType=IntegrationProcedure. The fullName is ProcedureName_SubType.
+
+Element types:
+- DataRaptor: call a DataRaptor for Salesforce CRUD
+- HTTPAction: call an external REST/SOAP API
+- Response: return data to the caller
+- Loop: iterate over a collection
+- Conditional: branch based on conditions
+- SetValues: set variables
+- ExceptionBlock: handle errors
+- Matrix: call a Calculation Matrix
+- OmniScript: call a nested OmniScript
+- Aggregate: combine multiple data sources
+
+Set isActive: true to activate immediately after creation.`,
+        inputSchema: CreateIntegrationProcedureSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createIntegrationProcedure(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_update_integration_procedure", {
+        title: "Update OmniStudio Integration Procedure",
+        description: `Updates an existing Integration Procedure's metadata (description, active status). Identified by procedureName + subType (fullName = procedureName_subType).
+
+For element/step changes, use the OmniStudio Integration Procedure Designer. Set isActive: false to deactivate, then make changes, then sf_activate_integration_procedure.`,
+        inputSchema: UpdateIntegrationProcedureSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await updateIntegrationProcedure(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_get_integration_procedure", {
+        title: "Get OmniStudio Integration Procedure",
+        description: `Retrieves the configuration of an Integration Procedure including its elements and activation status. Identified by procedureName + subType.`,
+        inputSchema: GetIntegrationProcedureSchema,
+        annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await getIntegrationProcedure(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_activate_integration_procedure", {
+        title: "Activate OmniStudio Integration Procedure",
+        description: `Activates an Integration Procedure so it can be invoked from OmniScripts, FlexCards, and APIs. Identified by procedureName + subType.`,
+        inputSchema: ActivateIntegrationProcedureSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await activateIntegrationProcedure(auth, params);
+        return resultContent(result);
+    });
+
+    // ─── CALCULATION MATRIX & PROCEDURE ──────────────────────────────────────
+    server.registerTool("sf_create_calculation_matrix", {
+        title: "Create OmniStudio Calculation Matrix",
+        description: `Creates a Calculation Matrix for rule-based lookups and calculations. Matrices map input combinations to output values — useful for pricing, eligibility, scoring, and decision tables.
+
+inputVariables: list of input variable names (columns used for lookups)
+outputVariables: list of output variable names (columns returned)
+rows: array of { inputs: {var: value}, outputs: {var: value} } defining the lookup table
+
+Example: a pricing matrix with inputs [ProductType, Region] and outputs [Price, Discount].`,
+        inputSchema: CreateCalculationMatrixSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createCalculationMatrix(auth, params);
+        return resultContent(result);
+    });
+
+    server.registerTool("sf_create_calculation_procedure", {
+        title: "Create OmniStudio Calculation Procedure",
+        description: `Creates a Calculation Procedure that orchestrates multi-step calculations using Calculation Matrices, formulas, and logic steps.
+
+steps array — each step has:
+- name: step identifier
+- type: MatrixLookup (call a matrix), Formula (expression), Condition (branch), Assignment (set variable)
+- matrixName: required for MatrixLookup steps
+- expression: required for Formula/Condition steps
+- inputMap: maps procedure variables to step inputs
+- outputMap: maps step outputs back to procedure variables
+
+Use Calculation Procedures to build complex pricing engines, eligibility calculators, or multi-factor scoring systems.`,
+        inputSchema: CreateCalculationProcedureSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createCalculationProcedure(auth, params);
+        return resultContent(result);
+    });
+}
+//# sourceMappingURL=omnistudio.js.map

package/dist/tools/ui.js

@@ -1,5 +1,5 @@
-import { CreateLightningAppSchema, CreateTabSchema, CreateCompactLayoutSchema, CreateListViewSchema, CreateEmailTemplateSchema, CreateStaticResourceSchema, CreateCustomNotificationTypeSchema, CreateReportTypeSchema, CreateDashboardSchema, UpdatePageLayoutSchema, AssignPageLayoutSchema, CreateLightningRecordPageSchema, CreateLightningHomePageSchema, UpdateLightningPageSchema, AssignLightningPageSchema, AssignCompactLayoutSchema, } from "../schemas/index.js";
-import { getAuth, createLightningApp, createTab, createCompactLayout, createListView, createEmailTemplate, createCustomNotificationType, createReportType, updatePageLayout, assignPageLayout, createFlexiPage, updateFlexiPage, assignFlexiPage, assignCompactLayout, } from "../services/salesforce.js";
+import { CreateLightningAppSchema, CreateTabSchema, CreateCompactLayoutSchema, CreateListViewSchema, CreateEmailTemplateSchema, CreateStaticResourceSchema, CreateCustomNotificationTypeSchema, CreateReportTypeSchema, CreateDashboardSchema, UpdatePageLayoutSchema, AssignPageLayoutSchema, CreateLightningRecordPageSchema, CreateLightningHomePageSchema, UpdateLightningPageSchema, AssignLightningPageSchema, AssignCompactLayoutSchema, CreateLightningAppPageSchema, CreateLetterheadSchema, } from "../schemas/index.js";
+import { getAuth, createLightningApp, createTab, createCompactLayout, createListView, createEmailTemplate, createCustomNotificationType, createReportType, updatePageLayout, assignPageLayout, createFlexiPage, updateFlexiPage, assignFlexiPage, assignCompactLayout, createLightningAppPage, createLetterhead, } from "../services/salesforce.js";
 import { buildStaticResourceZip, deployZip, pollDeployStatus, } from "../services/deployment.js";
 import { API_VERSION } from "../services/salesforce.js";
 import { resultContent } from "./utils.js";
@@ -261,5 +261,35 @@ export function registerUiTools(server) {
         const result = await assignCompactLayout(auth, params);
         return resultContent(result);
     });
+    server.registerTool("sf_create_lightning_app_page", {
+        title: "Create Lightning App Page (FlexiPage)",
+        description: `Creates a Lightning App Page (FlexiPage of type AppPage) for use in Lightning Apps. App Pages appear as tabs in a Lightning App and can display dashboards, lists, and custom components.
+
+template options: AppDefaultTemplate (single region), OneRegion, TwoColumn_LeftSidebar, TwoColumn_RightSidebar, ThreeColumn
+
+After creating, assign the page to a Lightning App via App Manager in Setup, or use the Lightning App Builder to activate it.`,
+        inputSchema: CreateLightningAppPageSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createLightningAppPage(auth, params);
+        return resultContent(result);
+    });
+    server.registerTool("sf_create_letterhead", {
+        title: "Create Email Letterhead",
+        description: `Creates an email letterhead (Letterhead metadata type) for use with Classic email templates. Letterheads define the visual branding of email templates — header/footer colors, fonts, separator lines, and logo placement.
+
+After creating a letterhead, reference it by API name when creating email templates (sf_create_email_template with htmlValue that includes the letterhead).
+
+headerColor/footerColor/bodyColor: hex color values (e.g. '#0070D2')
+fontName: font face, e.g. 'Arial', 'Helvetica', 'Times New Roman'
+footerText: optional static text shown in the footer`,
+        inputSchema: CreateLetterheadSchema,
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: true },
+    }, async (params) => {
+        const auth = await getAuth();
+        const result = await createLetterhead(auth, params);
+        return resultContent(result);
+    });
 }
 //# sourceMappingURL=ui.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "salesforce-metadata-mcp",
-  "version": "2.2.0",
-  "description": "The most comprehensive Salesforce MCP server: 110+ tools for metadata, Apex, LWC, Agentforce agents, Experience Cloud, bulk data, users, reports, security, and more",
+  "version": "2.4.0",
+  "description": "The most comprehensive Salesforce MCP server: 155+ tools covering custom objects, flows, Apex, LWC, page layouts, permissions, profiles, users, reports, dashboards, Experience Cloud, OmniStudio, OmniChannel, Agentforce, Einstein AI, audit trail, and more — everything a Salesforce admin, advanced admin and developer needs.",
   "license": "MIT",
   "private": false,
   "type": "module",
@@ -58,7 +58,30 @@
     "bulk-api",
     "visualforce",
     "aura",
-    "formula-fields"
+    "formula-fields",
+    "omnistudio",
+    "omniscript",
+    "flexcard",
+    "dataraptor",
+    "integration-procedure",
+    "omnichannel",
+    "service-cloud",
+    "field-service",
+    "messaging",
+    "live-chat",
+    "skill-routing",
+    "presence",
+    "einstein",
+    "next-best-action",
+    "audit-trail",
+    "login-history",
+    "lightning-page",
+    "flexipage",
+    "app-builder",
+    "letterhead",
+    "soql",
+    "github-actions",
+    "ci-cd"
   ],
   "dependencies": {
     "@modelcontextprotocol/sdk": "1.29.0",