@open-loyalty/mcp-server 1.0.3 → 1.3.1

package/dist/tools/index.js

@@ -1,13 +1,13 @@
 import { walletTypeToolDefinitions } from "./wallet-type.js";
 import { tiersetToolDefinitions } from "./tierset.js";
-import { memberToolDefinitions } from "./member.js";
+import { memberToolDefinitions } from "./member/index.js";
 import { pointsToolDefinitions } from "./points.js";
-import { rewardToolDefinitions } from "./reward.js";
+import { rewardToolDefinitions } from "./reward/index.js";
 import { transactionToolDefinitions } from "./transaction.js";
 // Phase 2 tools
-import { campaignToolDefinitions } from "./campaign.js";
-import { segmentToolDefinitions } from "./segment.js";
-import { achievementToolDefinitions } from "./achievement.js";
+import { campaignToolDefinitions } from "./campaign/index.js";
+import { segmentToolDefinitions } from "./segment/index.js";
+import { achievementToolDefinitions } from "./achievement/index.js";
 import { badgeToolDefinitions } from "./badge.js";
 // Phase 3 tools
 import { analyticsToolDefinitions } from "./analytics.js";
@@ -20,476 +20,14 @@ import { storeToolDefinitions } from "./store.js";
 import { webhookToolDefinitions } from "./webhook.js";
 import { importToolDefinitions } from "./import.js";
 import { exportToolDefinitions } from "./export.js";
-// User-friendly titles and behavior hints for each tool
-export const toolMetadata = {
-    // Wallet Types - read-only lookups
-    openloyalty_wallet_type_list: {
-        title: "List Point Currencies",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_wallet_type_get: {
-        title: "Get Point Currency Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Tier Sets
-    openloyalty_tierset_list: {
-        title: "List Loyalty Programs",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_tierset_create: {
-        title: "Create Loyalty Program",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_tierset_get: {
-        title: "Get Loyalty Program Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_tierset_update: {
-        title: "Update Loyalty Program",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_tierset_update_tiers: {
-        title: "Configure Tier Thresholds",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_tierset_get_tiers: {
-        title: "Get Tier Configuration",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Members
-    openloyalty_member_create: {
-        title: "Register New Member",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_member_get: {
-        title: "Get Member Profile",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_member_list: {
-        title: "Search Members",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_member_update: {
-        title: "Update Member Profile",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_member_activate: {
-        title: "Activate Member Account",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_member_deactivate: {
-        title: "Deactivate Member Account",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_member_delete: {
-        title: "Delete Member (Permanent)",
-        annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: true }
-    },
-    openloyalty_member_get_tier_progress: {
-        title: "Check Tier Progress",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_member_assign_tier: {
-        title: "Assign Tier to Member",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_member_remove_manual_tier: {
-        title: "Remove Manual Tier Assignment",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    // Points
-    openloyalty_points_add: {
-        title: "Add Points to Member",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_points_spend: {
-        title: "Spend Member Points",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_points_transfer: {
-        title: "Transfer Points Between Members",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_points_get_balance: {
-        title: "Check Points Balance",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_points_get_history: {
-        title: "View Points History",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_points_get_histogram: {
-        title: "View Points Trends",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Rewards
-    openloyalty_reward_list: {
-        title: "Browse Rewards",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_reward_create: {
-        title: "Create New Reward",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_reward_get: {
-        title: "Get Reward Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_reward_update: {
-        title: "Update Reward",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_reward_activate: {
-        title: "Activate Reward",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_reward_deactivate: {
-        title: "Deactivate Reward",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_reward_buy: {
-        title: "Redeem Reward for Member",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_reward_redeem: {
-        title: "Use Coupon Code",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_reward_category_list: {
-        title: "List Reward Categories",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Transactions
-    openloyalty_transaction_create: {
-        title: "Record Purchase",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_transaction_get: {
-        title: "Get Transaction Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_transaction_list: {
-        title: "Search Transactions",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_transaction_assign_member: {
-        title: "Link Transaction to Member",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    // Phase 2: Campaigns
-    openloyalty_campaign_list: {
-        title: "List Campaigns",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_campaign_create: {
-        title: "Create Campaign",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_campaign_get: {
-        title: "Get Campaign Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_campaign_update: {
-        title: "Update Campaign",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_campaign_patch: {
-        title: "Patch Campaign",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_campaign_delete: {
-        title: "Delete Campaign (Permanent)",
-        annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: true }
-    },
-    openloyalty_campaign_simulate: {
-        title: "Simulate Campaign Effects",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_campaign_generate_codes: {
-        title: "Generate Campaign Codes",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_campaign_list_codes: {
-        title: "List Campaign Codes",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_campaign_get_available: {
-        title: "Get Available Campaigns for Member",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_campaign_get_visible: {
-        title: "Get Visible Campaigns for Member",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_campaign_get_leaderboard: {
-        title: "Get Campaign Leaderboard",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 2: Segments
-    openloyalty_segment_list: {
-        title: "List Segments",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_segment_create: {
-        title: "Create Segment",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_segment_get: {
-        title: "Get Segment Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_segment_update: {
-        title: "Update Segment",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_segment_delete: {
-        title: "Delete Segment (Permanent)",
-        annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: true }
-    },
-    openloyalty_segment_get_members: {
-        title: "Get Segment Members",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_segment_activate: {
-        title: "Activate Segment",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_segment_deactivate: {
-        title: "Deactivate Segment",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_segment_get_resources: {
-        title: "Get Segment Resources",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 2: Achievements
-    openloyalty_achievement_list: {
-        title: "List Achievements",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_achievement_create: {
-        title: "Create Achievement",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_achievement_get: {
-        title: "Get Achievement Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_achievement_update: {
-        title: "Update Achievement",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_achievement_patch: {
-        title: "Patch Achievement",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_achievement_get_member_progress: {
-        title: "Get Member Achievement Progress",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_achievement_list_member_achievements: {
-        title: "List Member Achievements",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 2: Badges
-    openloyalty_badge_list: {
-        title: "List Badges",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_badge_get: {
-        title: "Get Badge Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_badge_update: {
-        title: "Update Badge",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_badge_get_member_badges: {
-        title: "Get Member Badges",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 3: Analytics
-    openloyalty_analytics_tiers: {
-        title: "Get Tier Analytics",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_members: {
-        title: "Get Member Analytics",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_points: {
-        title: "Get Points Analytics",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_transactions: {
-        title: "Get Transaction Analytics",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_referrals: {
-        title: "Get Referral Analytics",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_campaigns: {
-        title: "Get Campaign Analytics",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_dashboard: {
-        title: "Get Dashboard Overview",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_units: {
-        title: "Get Units Overview",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_analytics_campaign_detail: {
-        title: "Get Campaign Detail Analytics",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 3: Admin Users
-    openloyalty_admin_list: {
-        title: "List Admin Users",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_admin_create: {
-        title: "Create Admin User",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_admin_get: {
-        title: "Get Admin User Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_admin_update: {
-        title: "Update Admin User",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_admin_change_password: {
-        title: "Change Admin Password",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_admin_get_permissions: {
-        title: "Get Admin Permissions",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 3: Roles/ACL
-    openloyalty_role_list: {
-        title: "List Roles",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_role_create: {
-        title: "Create Role",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_role_get: {
-        title: "Get Role Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_role_update: {
-        title: "Update Role",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_role_delete: {
-        title: "Delete Role (Permanent)",
-        annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: true }
-    },
-    openloyalty_acl_get_resources: {
-        title: "Get ACL Resources",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 3: API Keys
-    openloyalty_apikey_create: {
-        title: "Create API Key",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_apikey_list: {
-        title: "List API Keys",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_apikey_delete: {
-        title: "Delete API Key (Permanent)",
-        annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: true }
-    },
-    // Phase 3: Audit Logs
-    openloyalty_audit_list: {
-        title: "List Audit Logs",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_audit_export: {
-        title: "Export Audit Logs",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    // Phase 3: Stores
-    openloyalty_store_list: {
-        title: "List Stores",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_store_create: {
-        title: "Create Store",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_store_get: {
-        title: "Get Store Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_store_update: {
-        title: "Update Store",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    // Phase 4: Webhooks
-    openloyalty_webhook_list: {
-        title: "List Webhook Subscriptions",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_webhook_create: {
-        title: "Create Webhook Subscription",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_webhook_get: {
-        title: "Get Webhook Subscription Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_webhook_update: {
-        title: "Update Webhook Subscription",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_webhook_delete: {
-        title: "Delete Webhook Subscription (Permanent)",
-        annotations: { readOnlyHint: false, destructiveHint: true, openWorldHint: true }
-    },
-    openloyalty_webhook_events: {
-        title: "List Available Webhook Events",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 4: Import
-    openloyalty_import_create: {
-        title: "Create Bulk Import",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_import_list: {
-        title: "List Imports",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_import_get: {
-        title: "Get Import Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    // Phase 4: Export
-    openloyalty_export_create: {
-        title: "Create Data Export",
-        annotations: { readOnlyHint: false, openWorldHint: true }
-    },
-    openloyalty_export_list: {
-        title: "List Exports",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_export_get: {
-        title: "Get Export Details",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-    openloyalty_export_download: {
-        title: "Download Export File",
-        annotations: { readOnlyHint: true, openWorldHint: true }
-    },
-};
+// Custom event tools (needed for custom_event trigger in campaigns/achievements)
+import { customEventToolDefinitions } from "./custom-event.js";
+// Referral tools (needed for referral tracking between members)
+import { referralToolDefinitions } from "./referral/index.js";
+// Collect all tool definitions
+// Note: Single cast needed because tool handlers have specific input types
+// (e.g., { memberId: string }) while ToolDefinition uses generic Record<string, unknown>.
+// This is safe because Zod validates inputs at runtime before handlers are called.
 const allTools = [
     // Phase 1 tools
     ...walletTypeToolDefinitions,
@@ -514,6 +52,10 @@ const allTools = [
     ...webhookToolDefinitions,
     ...importToolDefinitions,
     ...exportToolDefinitions,
+    // Custom event tools
+    ...customEventToolDefinitions,
+    // Referral tools
+    ...referralToolDefinitions,
 ];
 const toolHandlers = new Map();
 for (const tool of allTools) {

package/dist/tools/member/handlers.d.ts

@@ -0,0 +1,111 @@
+import { Member } from "../../types/schemas/member.js";
+export declare function memberCreate(input: {
+    storeCode?: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    birthDate?: string;
+    gender?: string;
+    loyaltyCardNumber?: string;
+    agreement1?: boolean;
+    agreement2?: boolean;
+    agreement3?: boolean;
+    address?: {
+        street?: string;
+        city?: string;
+        postal?: string;
+        country?: string;
+        province?: string;
+    };
+}): Promise<{
+    memberId: string;
+    loyaltyCardNumber: string;
+    email: string;
+}>;
+export declare function memberGet(input: {
+    storeCode?: string;
+    memberId: string;
+}): Promise<Member>;
+export declare function memberList(input: {
+    storeCode?: string;
+    cursor?: string;
+    page?: number;
+    perPage?: number;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    loyaltyCardNumber?: string;
+    active?: boolean;
+}): Promise<{
+    members: Array<{
+        memberId: string;
+        email: string;
+        firstName?: string;
+        lastName?: string;
+        loyaltyCardNumber?: string;
+        active: boolean;
+    }>;
+    total: {
+        all?: number;
+        filtered?: number;
+    };
+    cursor?: string;
+}>;
+export declare function memberUpdate(input: {
+    storeCode?: string;
+    memberId: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    birthDate?: string;
+    gender?: string;
+    address?: {
+        street?: string;
+        city?: string;
+        postal?: string;
+        country?: string;
+        province?: string;
+    };
+    agreement1?: boolean;
+    agreement2?: boolean;
+    agreement3?: boolean;
+}): Promise<void>;
+export declare function memberActivate(input: {
+    storeCode?: string;
+    memberId: string;
+}): Promise<void>;
+export declare function memberDeactivate(input: {
+    storeCode?: string;
+    memberId: string;
+}): Promise<void>;
+export declare function memberDelete(input: {
+    storeCode?: string;
+    memberId: string;
+}): Promise<void>;
+export declare function memberGetTierProgress(input: {
+    storeCode?: string;
+    memberId: string;
+}): Promise<{
+    currentTier?: {
+        levelId: string;
+        name: string;
+    };
+    nextTier?: {
+        levelId: string;
+        name: string;
+    };
+    currentValue: number;
+    requiredValue?: number;
+    progressPercent: number;
+}>;
+export declare function memberAssignTier(input: {
+    storeCode?: string;
+    memberId: string;
+    levelId: string;
+}): Promise<void>;
+export declare function memberRemoveManualTier(input: {
+    storeCode?: string;
+    memberId: string;
+}): Promise<void>;