@open-loyalty/mcp-server 1.0.2 → 1.1.0

package/dist/tools/member.js

@@ -2,8 +2,9 @@ import { z } from "zod";
 import { apiGet, apiPost, apiPut, apiDelete } from "../client/http.js";
 import { MemberSchema, } from "../types/schemas/member.js";
 import { formatApiError } from "../utils/errors.js";
-import { getConfig } from "../config.js";
+import { getStoreCode } from "../config.js";
 import { buildPaginationParams } from "../utils/pagination.js";
+import { omitUndefined } from "../utils/payload.js";
 // Input Schemas
 export const MemberCreateInputSchema = {
     storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
@@ -71,31 +72,20 @@ export const MemberAssignTierInputSchema = {
 };
 // Handler functions
 export async function memberCreate(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
-    const payload = {
+    const storeCode = getStoreCode(input.storeCode);
+    const payload = omitUndefined({
         email: input.email,
-    };
-    if (input.firstName)
-        payload.firstName = input.firstName;
-    if (input.lastName)
-        payload.lastName = input.lastName;
-    if (input.phone)
-        payload.phone = input.phone;
-    if (input.birthDate)
-        payload.birthDate = input.birthDate;
-    if (input.gender)
-        payload.gender = input.gender;
-    if (input.loyaltyCardNumber)
-        payload.loyaltyCardNumber = input.loyaltyCardNumber;
-    if (input.agreement1 !== undefined)
-        payload.agreement1 = input.agreement1;
-    if (input.agreement2 !== undefined)
-        payload.agreement2 = input.agreement2;
-    if (input.agreement3 !== undefined)
-        payload.agreement3 = input.agreement3;
-    if (input.address)
-        payload.address = input.address;
+        firstName: input.firstName,
+        lastName: input.lastName,
+        phone: input.phone,
+        birthDate: input.birthDate,
+        gender: input.gender,
+        loyaltyCardNumber: input.loyaltyCardNumber,
+        agreement1: input.agreement1,
+        agreement2: input.agreement2,
+        agreement3: input.agreement3,
+        address: input.address,
+    });
     try {
         const response = await apiPost(`/${storeCode}/member`, { customer: payload });
         return {
@@ -109,8 +99,7 @@ export async function memberCreate(input) {
     }
 }
 export async function memberGet(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         const response = await apiGet(`/${storeCode}/member/${input.memberId}`);
         // Map API response to our schema
@@ -141,8 +130,7 @@ export async function memberGet(input) {
     }
 }
 export async function memberList(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     // Use buildPaginationParams for cursor/page handling
     buildPaginationParams({ cursor: input.cursor, page: input.page, perPage: input.perPage }, params);
@@ -188,27 +176,18 @@ export async function memberList(input) {
     }
 }
 export async function memberUpdate(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
-    const payload = {};
-    if (input.firstName)
-        payload.firstName = input.firstName;
-    if (input.lastName)
-        payload.lastName = input.lastName;
-    if (input.phone)
-        payload.phone = input.phone;
-    if (input.birthDate)
-        payload.birthDate = input.birthDate;
-    if (input.gender)
-        payload.gender = input.gender;
-    if (input.address)
-        payload.address = input.address;
-    if (input.agreement1 !== undefined)
-        payload.agreement1 = input.agreement1;
-    if (input.agreement2 !== undefined)
-        payload.agreement2 = input.agreement2;
-    if (input.agreement3 !== undefined)
-        payload.agreement3 = input.agreement3;
+    const storeCode = getStoreCode(input.storeCode);
+    const payload = omitUndefined({
+        firstName: input.firstName,
+        lastName: input.lastName,
+        phone: input.phone,
+        birthDate: input.birthDate,
+        gender: input.gender,
+        address: input.address,
+        agreement1: input.agreement1,
+        agreement2: input.agreement2,
+        agreement3: input.agreement3,
+    });
     try {
         await apiPut(`/${storeCode}/member/${input.memberId}`, { customer: payload });
     }
@@ -217,8 +196,7 @@ export async function memberUpdate(input) {
     }
 }
 export async function memberActivate(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         await apiPost(`/${storeCode}/member/${input.memberId}/activate`);
     }
@@ -227,8 +205,7 @@ export async function memberActivate(input) {
     }
 }
 export async function memberDeactivate(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         await apiPost(`/${storeCode}/member/${input.memberId}/deactivate`);
     }
@@ -237,8 +214,7 @@ export async function memberDeactivate(input) {
     }
 }
 export async function memberDelete(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         await apiDelete(`/${storeCode}/member/${input.memberId}`);
     }
@@ -247,8 +223,7 @@ export async function memberDelete(input) {
     }
 }
 export async function memberGetTierProgress(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         const response = await apiGet(`/${storeCode}/member/${input.memberId}/tier`);
         const currentLevel = response.currentLevel;
@@ -272,8 +247,7 @@ export async function memberGetTierProgress(input) {
     }
 }
 export async function memberAssignTier(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         await apiPost(`/${storeCode}/member/${input.memberId}/tier`, { levelId: input.levelId });
     }
@@ -282,8 +256,7 @@ export async function memberAssignTier(input) {
     }
 }
 export async function memberRemoveManualTier(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     try {
         // API uses POST to /remove-manually-level, not DELETE to /tier
         await apiPost(`/${storeCode}/member/${input.memberId}/remove-manually-level`);
@@ -296,62 +269,83 @@ export async function memberRemoveManualTier(input) {
 export const memberToolDefinitions = [
     {
         name: "openloyalty_member_create",
+        title: "Register New Member",
         description: "Register a new loyalty program member. Returns memberId for subsequent operations like points_add or member_get. Email must be unique within the store.",
+        readOnly: false,
         inputSchema: MemberCreateInputSchema,
         handler: memberCreate,
     },
     {
         name: "openloyalty_member_get",
+        title: "Get Member Profile",
         description: "Get member details including profile, points balance, and tier status. Use memberId from member_create or member_list.",
+        readOnly: true,
         inputSchema: MemberGetInputSchema,
         handler: memberGet,
     },
     {
         name: "openloyalty_member_list",
+        title: "Search Members",
         description: "Search and list members with optional filters. Use member_get for full details of a specific member. " +
             "Supports cursor pagination: provide 'cursor' from previous response to get next page.",
+        readOnly: true,
         inputSchema: MemberListInputSchema,
         handler: memberList,
     },
     {
         name: "openloyalty_member_update",
+        title: "Update Member Profile",
         description: "Update member profile fields. Cannot change email. Use member_get first to see current values.",
+        readOnly: false,
         inputSchema: MemberUpdateInputSchema,
         handler: memberUpdate,
     },
     {
         name: "openloyalty_member_activate",
+        title: "Activate Member Account",
         description: "Activate a member account. Inactive members cannot earn or spend points.",
+        readOnly: false,
         inputSchema: MemberIdInputSchema,
         handler: memberActivate,
     },
     {
         name: "openloyalty_member_deactivate",
+        title: "Deactivate Member Account",
         description: "Deactivate a member account. Deactivated members cannot earn or spend points but retain their balance.",
+        readOnly: false,
         inputSchema: MemberIdInputSchema,
         handler: memberDeactivate,
     },
     {
         name: "openloyalty_member_delete",
+        title: "Delete Member (Permanent)",
         description: "Permanently removes member and all associated data. Cannot be undone. Use for GDPR compliance or member requests.",
+        readOnly: false,
+        destructive: true,
         inputSchema: MemberIdInputSchema,
         handler: memberDelete,
     },
     {
         name: "openloyalty_member_get_tier_progress",
+        title: "Check Tier Progress",
         description: "Get member tier progression status showing current tier and progress to next. Returns currentValue, requiredValue, and progressPercent.",
+        readOnly: true,
         inputSchema: MemberIdInputSchema,
         handler: memberGetTierProgress,
     },
     {
         name: "openloyalty_member_assign_tier",
+        title: "Assign Tier to Member",
         description: "Manually assign a tier level to a member, overriding automatic tier calculation. Use tierset_get_tiers to find available levelId values.",
+        readOnly: false,
         inputSchema: MemberAssignTierInputSchema,
         handler: memberAssignTier,
     },
     {
         name: "openloyalty_member_remove_manual_tier",
+        title: "Remove Manual Tier Assignment",
         description: "Remove manually assigned tier from member, restoring automatic tier calculation based on conditions.",
+        readOnly: false,
         inputSchema: MemberIdInputSchema,
         handler: memberRemoveManualTier,
     },

package/dist/tools/points.d.ts

@@ -119,7 +119,9 @@ export declare function pointsGetHistogram(input: {
 }>>;
 export declare const pointsToolDefinitions: readonly [{
     readonly name: "openloyalty_points_add";
+    readonly title: "Add Points to Member";
     readonly description: string;
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         memberId: z.ZodString;
@@ -132,7 +134,9 @@ export declare const pointsToolDefinitions: readonly [{
     readonly handler: typeof pointsAdd;
 }, {
     readonly name: "openloyalty_points_spend";
+    readonly title: "Spend Member Points";
     readonly description: string;
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         memberId: z.ZodString;
@@ -143,7 +147,9 @@ export declare const pointsToolDefinitions: readonly [{
     readonly handler: typeof pointsSpend;
 }, {
     readonly name: "openloyalty_points_transfer";
+    readonly title: "Transfer Points Between Members";
     readonly description: string;
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         senderId: z.ZodString;
@@ -153,7 +159,9 @@ export declare const pointsToolDefinitions: readonly [{
     readonly handler: typeof pointsTransfer;
 }, {
     readonly name: "openloyalty_points_get_balance";
+    readonly title: "Check Points Balance";
     readonly description: string;
+    readonly readOnly: true;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         memberId: z.ZodString;
@@ -162,7 +170,9 @@ export declare const pointsToolDefinitions: readonly [{
     readonly handler: typeof pointsGetBalance;
 }, {
     readonly name: "openloyalty_points_get_history";
+    readonly title: "View Points History";
     readonly description: string;
+    readonly readOnly: true;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         memberId: z.ZodString;
@@ -174,7 +184,9 @@ export declare const pointsToolDefinitions: readonly [{
     readonly handler: typeof pointsGetHistory;
 }, {
     readonly name: "openloyalty_points_get_histogram";
+    readonly title: "View Points Trends";
     readonly description: string;
+    readonly readOnly: true;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         memberId: z.ZodString;

package/dist/tools/points.js

@@ -1,8 +1,9 @@
 import { z } from "zod";
 import { apiGet, apiPost } from "../client/http.js";
 import { formatApiError, OpenLoyaltyError } from "../utils/errors.js";
-import { getConfig } from "../config.js";
+import { getStoreCode } from "../config.js";
 import { buildPaginationParams } from "../utils/pagination.js";
+import { omitUndefined } from "../utils/payload.js";
 // Input Schemas
 export const PointsAddInputSchema = {
     storeCode: z.string().optional().describe("Store code. If not provided, uses the default store code from configuration."),
@@ -50,19 +51,14 @@ export const PointsHistogramInputSchema = {
 };
 // Handler functions
 export async function pointsAdd(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
-    const payload = {
+    const storeCode = getStoreCode(input.storeCode);
+    const payload = omitUndefined({
         points: input.points,
-    };
-    if (input.walletCode)
-        payload.walletCode = input.walletCode;
-    if (input.comment)
-        payload.comment = input.comment;
-    if (input.expiresInDays)
-        payload.expiresInDays = input.expiresInDays;
-    if (input.lockedUntilDays)
-        payload.lockedUntilDays = input.lockedUntilDays;
+        walletCode: input.walletCode,
+        comment: input.comment,
+        expiresInDays: input.expiresInDays,
+        lockedUntilDays: input.lockedUntilDays,
+    });
     try {
         const response = await apiPost(`/${storeCode}/points/add`, { transfer: { customer: input.memberId, ...payload } });
         return { transferId: response.transferId };
@@ -72,15 +68,12 @@ export async function pointsAdd(input) {
     }
 }
 export async function pointsSpend(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
-    const payload = {
+    const storeCode = getStoreCode(input.storeCode);
+    const payload = omitUndefined({
         points: input.points,
-    };
-    if (input.walletCode)
-        payload.walletCode = input.walletCode;
-    if (input.comment)
-        payload.comment = input.comment;
+        walletCode: input.walletCode,
+        comment: input.comment,
+    });
     try {
         const response = await apiPost(`/${storeCode}/points/spend`, { transfer: { customer: input.memberId, ...payload } });
         return { transferId: response.transferId };
@@ -100,8 +93,7 @@ export async function pointsSpend(input) {
     }
 }
 export async function pointsTransfer(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     if (input.senderId === input.receiverId) {
         throw new Error("Cannot transfer points to yourself. senderId and receiverId must be different.");
     }
@@ -130,8 +122,7 @@ export async function pointsTransfer(input) {
     }
 }
 export async function pointsGetBalance(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     if (input.walletCode)
         params.append("walletType:code", input.walletCode);
@@ -180,8 +171,7 @@ export async function pointsGetBalance(input) {
     }
 }
 export async function pointsGetHistory(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     params.append("member:id", input.memberId);
     // Use buildPaginationParams for cursor/page handling
@@ -218,8 +208,7 @@ export async function pointsGetHistory(input) {
     }
 }
 export async function pointsGetHistogram(input) {
-    const config = getConfig();
-    const storeCode = input.storeCode || config.defaultStoreCode;
+    const storeCode = getStoreCode(input.storeCode);
     const params = new URLSearchParams();
     params.append("member:id", input.memberId);
     // pointType is required by the API: spent|earned|expired|pending
@@ -262,44 +251,56 @@ export async function pointsGetHistogram(input) {
 export const pointsToolDefinitions = [
     {
         name: "openloyalty_points_add",
+        title: "Add Points to Member",
         description: "Add points to member wallet. Points can have optional expiration and lock period. " +
             "Use for welcome bonuses, manual adjustments, or custom rewards. Returns transferId.",
+        readOnly: false,
         inputSchema: PointsAddInputSchema,
         handler: pointsAdd,
     },
     {
         name: "openloyalty_points_spend",
+        title: "Spend Member Points",
         description: "Deduct points from member wallet. Fails if insufficient balance. " +
             "Use points_get_balance first to verify available points. Returns transferId.",
+        readOnly: false,
         inputSchema: PointsSpendInputSchema,
         handler: pointsSpend,
     },
     {
         name: "openloyalty_points_transfer",
+        title: "Transfer Points Between Members",
         description: "Transfer points from one member to another (P2P transfer). " +
             "Sender must have sufficient balance. Returns transferId.",
+        readOnly: false,
         inputSchema: PointsTransferInputSchema,
         handler: pointsTransfer,
     },
     {
         name: "openloyalty_points_get_balance",
+        title: "Check Points Balance",
         description: "Get member points balance breakdown. activeUnits is available for spending. " +
             "earnedUnits shows lifetime earnings, lockedUnits shows pending points.",
+        readOnly: true,
         inputSchema: PointsBalanceInputSchema,
         handler: pointsGetBalance,
     },
     {
         name: "openloyalty_points_get_history",
+        title: "View Points History",
         description: "Get points transaction history for a member. Filter by type: adding, spending, " +
             "p2p_spending, p2p_adding, blocked, expired. Returns paginated list of transfers. " +
             "Supports cursor pagination: provide 'cursor' from previous response to get next page.",
+        readOnly: true,
         inputSchema: PointsHistoryInputSchema,
         handler: pointsGetHistory,
     },
     {
         name: "openloyalty_points_get_histogram",
+        title: "View Points Trends",
         description: "Get points histogram data for visualization. Shows earning and spending patterns over time. " +
             "Use interval (day/week/month) to aggregate data and dateFrom/dateTo to filter range.",
+        readOnly: true,
         inputSchema: PointsHistogramInputSchema,
         handler: pointsGetHistogram,
     },

package/dist/tools/reward.d.ts

@@ -158,7 +158,9 @@ export declare function rewardCategoryList(input: {
 }>;
 export declare const rewardToolDefinitions: readonly [{
     readonly name: "openloyalty_reward_list";
+    readonly title: "Browse Rewards";
     readonly description: string;
+    readonly readOnly: true;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         page: z.ZodOptional<z.ZodNumber>;
@@ -170,7 +172,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardList;
 }, {
     readonly name: "openloyalty_reward_create";
+    readonly title: "Create New Reward";
     readonly description: string;
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         name: z.ZodString;
@@ -190,7 +194,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardCreate;
 }, {
     readonly name: "openloyalty_reward_get";
+    readonly title: "Get Reward Details";
     readonly description: "Get full reward details including configuration, targeting, and coupon settings.";
+    readonly readOnly: true;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         rewardId: z.ZodString;
@@ -198,7 +204,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardGet;
 }, {
     readonly name: "openloyalty_reward_update";
+    readonly title: "Update Reward";
     readonly description: "Update reward configuration. Cannot change reward type after creation.";
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         rewardId: z.ZodString;
@@ -213,7 +221,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardUpdate;
 }, {
     readonly name: "openloyalty_reward_activate";
+    readonly title: "Activate Reward";
     readonly description: "Activate a reward, making it available for members to redeem.";
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         rewardId: z.ZodString;
@@ -221,7 +231,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardActivate;
 }, {
     readonly name: "openloyalty_reward_deactivate";
+    readonly title: "Deactivate Reward";
     readonly description: "Deactivate a reward, hiding it from members. Already purchased rewards remain valid.";
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         rewardId: z.ZodString;
@@ -229,7 +241,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardDeactivate;
 }, {
     readonly name: "openloyalty_reward_buy";
+    readonly title: "Redeem Reward for Member";
     readonly description: string;
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         rewardId: z.ZodString;
@@ -241,7 +255,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardBuy;
 }, {
     readonly name: "openloyalty_reward_redeem";
+    readonly title: "Use Coupon Code";
     readonly description: string;
+    readonly readOnly: false;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         memberId: z.ZodString;
@@ -250,7 +266,9 @@ export declare const rewardToolDefinitions: readonly [{
     readonly handler: typeof rewardRedeem;
 }, {
     readonly name: "openloyalty_reward_category_list";
+    readonly title: "List Reward Categories";
     readonly description: "List reward categories. Use categoryId when creating or filtering rewards.";
+    readonly readOnly: true;
     readonly inputSchema: {
         storeCode: z.ZodOptional<z.ZodString>;
         page: z.ZodOptional<z.ZodNumber>;