@stubbedev/trimit-mcp 0.1.0

package/dist/categories/masterdata.js

@@ -0,0 +1,246 @@
+import { z } from "zod";
+import { TRIMIT_AUTH, buildHeaders, buildOdataQuery, fetchExample, trimitBase } from "../common.js";
+const CATEGORY = "masterdata";
+export const masterdataTools = [
+    {
+        name: "trimit_masterdata_get_campaigns",
+        description: "List TRIMIT Campaigns. Expands defaultDimensions and priceGroupParameters by default. Fields: id, number, description, salespersonCode, statusCode, startingDate, endingDate, activated, lastDateModified.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'defaultDimensions,priceGroupParameters'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "defaultDimensions,priceGroupParameters";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/campaigns${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "List TRIMIT Campaigns with default dimensions and price group parameters.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: "lastDateModified is your incremental sync cursor — filter on it for deltas (BC has no /delta endpoint here).",
+            };
+        },
+    },
+    {
+        name: "trimit_masterdata_get_customer_price_groups",
+        description: "List Customer Price Groups with priceGroupParameters expanded. Supports $schemaversion=1.0.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'priceGroupParameters'"),
+            schemaVersion: z.string().optional().describe("e.g. '1.0'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "priceGroupParameters";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            let endpoint = `${trimitBase()}/customerPriceGroups${qs}`;
+            if (args.schemaVersion) {
+                const sep = endpoint.includes("?") ? "&" : "?";
+                endpoint = `${endpoint}${sep}$schemaversion=${args.schemaVersion}`;
+                params["$schemaversion"] = args.schemaVersion;
+            }
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Customer Price Groups list.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_masterdata_get_price_group_parameters",
+        description: "List Customer Price Group Parameters table directly. Recommended Data-Access-Intent: ReadOnly for large reads.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+            readOnly: z.boolean().optional().describe("Send Data-Access-Intent: ReadOnly header. Default true."),
+        },
+        handler: (args) => {
+            const { qs, params } = buildOdataQuery(args);
+            const endpoint = `${trimitBase()}/priceGroupParameters${qs}`;
+            const extra = args.readOnly !== false ? { "Data-Access-Intent": "ReadOnly" } : undefined;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(extra),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Read price group parameters.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null, extra),
+                auth: TRIMIT_AUTH,
+                notes: "Data-Access-Intent: ReadOnly routes the request to a read replica when BC supports it — lower latency for analytics-style reads.",
+            };
+        },
+    },
+    {
+        name: "trimit_masterdata_get_vardim_combinations",
+        description: "List allowed VarDim Combinations (overall + subordinate variant dimension pairings).",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const { qs, params } = buildOdataQuery(args);
+            const endpoint = `${trimitBase()}/VarDimCombinations${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "VarDim combinations (allowed variant dimension pairs).",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_masterdata_get_vardim_types",
+        description: "List VarDim Types (variant dimension definitions). Use $expand=vardimtypevalues to include values.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional().describe("e.g. \"No eq 'GL01'\""),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("e.g. 'vardimtypevalues'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const { qs, params } = buildOdataQuery(args);
+            const endpoint = `${trimitBase()}/vardimtypes${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "VarDim types.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_masterdata_get_vardim_type_values",
+        description: "List VarDim Type values (concrete variant dimension options).",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional().describe("e.g. \"value eq 'GB33'\""),
+            select: z.array(z.string()).optional(),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const { qs, params } = buildOdataQuery(args);
+            const endpoint = `${trimitBase()}/vardimtypevalues${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "VarDim type values.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_masterdata_get_item_attributes",
+        description: "List BC Item Attributes and their values.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+            readOnly: z.boolean().optional().describe("Send Data-Access-Intent: ReadOnly header. Default true."),
+        },
+        handler: (args) => {
+            const { qs, params } = buildOdataQuery(args);
+            const endpoint = `${trimitBase()}/itemAttributes${qs}`;
+            const extra = args.readOnly !== false ? { "Data-Access-Intent": "ReadOnly" } : undefined;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(extra),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Item attributes.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null, extra),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_masterdata_get_collections",
+        description: "List TRIMIT Collections (seasonal / grouping). Expand deliveryPeriods for delivery cycle data.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'deliveryPeriods'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "deliveryPeriods";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/collections${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "TRIMIT Collections.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+];

package/dist/categories/metadata.js

@@ -0,0 +1,27 @@
+import { HOST, TRIMIT_API_PATH, TRIMIT_AUTH, buildHeaders, fetchExample } from "../common.js";
+const CATEGORY = "metadata";
+export const metadataTools = [
+    {
+        name: "trimit_metadata_get",
+        description: "Get the CSDL/EDMX $metadata document for the TRIMIT Integration API (v1.1). Use for client codegen.",
+        category: CATEGORY,
+        zodShape: {},
+        handler: () => {
+            const endpoint = `${HOST}/{tenant}/{environment}/${TRIMIT_API_PATH}/$metadata`;
+            const extra = { Accept: "application/xml" };
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(extra),
+                pathParams: { tenant: "{tenant}", environment: "{environment}" },
+                queryParams: {},
+                body: null,
+                description: "TRIMIT $metadata — XML EDMX schema for the integration API.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null, extra),
+                auth: TRIMIT_AUTH,
+                notes: "Different document from the BC standard /api/v2.0/$metadata — this one lists only TRIMIT entities.",
+            };
+        },
+    },
+];

package/dist/categories/postedsales.js

@@ -0,0 +1,155 @@
+import { z } from "zod";
+import { TRIMIT_AUTH, buildHeaders, buildOdataQuery, fetchExample, trimitBase } from "../common.js";
+const CATEGORY = "postedsales";
+export const postedsalesTools = [
+    {
+        name: "trimit_postedsales_list_documents",
+        description: "List posted sales documents (union of posted invoices + posted credit memos).",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'postedSalesDocumentLines'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "postedSalesDocumentLines";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/postedSalesDocuments${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Posted sales documents.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_postedsales_list_invoices",
+        description: "List posted sales invoices (Sales Invoice Header).",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'postedSalesInvoiceLines,trackingLines'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "postedSalesInvoiceLines,trackingLines";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/postedSalesInvoices${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Posted sales invoices.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_postedsales_list_credit_memos",
+        description: "List posted sales credit memos.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'postedSalesCreditMemoLines,trackingLines'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "postedSalesCreditMemoLines,trackingLines";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/postedSalesCreditMemos${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Posted credit memos.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_postedsales_list_return_receipts",
+        description: "List posted sales return receipts (Return Receipt Header).",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'postedSalesReturnReceiptLines'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "postedSalesReturnReceiptLines";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/postedSalesReturnReceipts${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Posted return receipts (read-only).",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+    {
+        name: "trimit_postedsales_list_shipments",
+        description: "List posted sales shipments with tracking lines.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe("Default: 'postedSalesShipmentLines,trackingLines'"),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? "postedSalesShipmentLines,trackingLines";
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/postedSalesShipments${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "Posted shipments.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: "trackingLines contain serial / package tracking data when configured in BC.",
+            };
+        },
+    },
+];

package/dist/categories/products.js

@@ -0,0 +1,176 @@
+import { z } from "zod";
+import { TRIMIT_AUTH, buildHeaders, buildOdataQuery, fetchExample, trimitBase } from "../common.js";
+const CATEGORY = "products";
+const MASTERS_DEFAULT_EXPAND = [
+    "masterDescriptions",
+    "masterDefDims",
+    "masterAttributes",
+    "masterStatGroups",
+    "masterVarDims",
+    "masterCollections",
+    "masterCompositions",
+    "masterAddInfos",
+    "masterCarelabels",
+    "masterAddTags",
+    "masterSustainabilities",
+    "masterMeasureCharts",
+    "masterItems",
+    "masterInventories",
+    "masterImages",
+    "masterPrices",
+    "masterChoicelists",
+    "configuredFields",
+].join(",");
+const ITEMS_DEFAULT_EXPAND = [
+    "unitOfMeasure",
+    "extendedDescriptions",
+    "defaultDimensions",
+    "attributes",
+    "itemStatGroups",
+    "picture",
+    "itemCompositions",
+    "itemAddInfos",
+    "itemCarelabels",
+    "itemAddTags",
+    "itemSustainabilities",
+    "itemInventories",
+    "itemPrices",
+    "configuredFields",
+].join(",");
+const PRODUCTS_DEFAULT_EXPAND = [
+    "productDescriptions",
+    "productDefDims",
+    "productAttributes",
+    "productStatGroups",
+    "productVarDims",
+    "productCollections",
+    "productCompositions",
+    "productAddInfos",
+    "productCarelabels",
+    "productAddTags",
+    "productSustainabilities",
+    "productMeasureCharts",
+    "productItems",
+    "productPrices",
+    "configuredFields",
+].join(",");
+export const productsTools = [
+    {
+        name: "trimit_products_get_masters",
+        description: "List TRIMIT Masters (style/master products). Wide $expand by default — covers descriptions, dimensions, attributes, statistics groups, variants, collections, compositions, additional info, care labels, tags, sustainabilities, measure charts, items, inventories, images, prices, choicelists, and configuredFields.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe(`Default expand: ${MASTERS_DEFAULT_EXPAND}`),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? MASTERS_DEFAULT_EXPAND;
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/masters${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "TRIMIT Masters (style headers).",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: "Key fields: number (master code), noSystem (SKU template), masterItems → SKU variants. Heavy payload — narrow with $select and trimmed $expand for production traffic.",
+            };
+        },
+    },
+    {
+        name: "trimit_products_get_items",
+        description: "List TRIMIT-enriched items (SKUs) with picture, prices, attributes, compositions, inventories, configured fields, and more.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe(`Default expand: ${ITEMS_DEFAULT_EXPAND}`),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? ITEMS_DEFAULT_EXPAND;
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/items${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "TRIMIT items list with full expand.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: "Different resource from /companies(...)/items in the Standard API — same name, but this one has TRIMIT extensions (variants link, sustainabilities, configuredFields).",
+            };
+        },
+    },
+    {
+        name: "trimit_products_get_products",
+        description: "Curated product list (Masters + Items from configured BC categories). Suitable for storefront sync.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            expand: z.string().optional().describe(`Default expand: ${PRODUCTS_DEFAULT_EXPAND}`),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const expand = args.expand ?? PRODUCTS_DEFAULT_EXPAND;
+            const { qs, params } = buildOdataQuery({ ...args, expand });
+            const endpoint = `${trimitBase()}/products${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "TRIMIT Products feed.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: "Filter on lastDateModified for delta sync. Configure which BC categories feed this endpoint in TRIMIT setup.",
+            };
+        },
+    },
+    {
+        name: "trimit_products_get_categories",
+        description: "List TRIMIT Categories used to drive the /products feed.",
+        category: CATEGORY,
+        zodShape: {
+            filter: z.string().optional(),
+            select: z.array(z.string()).optional(),
+            top: z.number().optional(),
+            skip: z.number().optional(),
+        },
+        handler: (args) => {
+            const { qs, params } = buildOdataQuery(args);
+            const endpoint = `${trimitBase()}/categories${qs}`;
+            return {
+                endpoint,
+                method: "GET",
+                headers: buildHeaders(),
+                pathParams: { tenant: "{tenant}", environment: "{environment}", companyId: "{companyId}" },
+                queryParams: params,
+                body: null,
+                description: "TRIMIT Categories.",
+                docsUrl: "https://apidocs.trimit.com/",
+                codeExample: fetchExample(endpoint, "GET", null),
+                auth: TRIMIT_AUTH,
+                notes: null,
+            };
+        },
+    },
+];