@open-loyalty/mcp-server 1.8.0 → 1.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/dist/config.d.ts +0 -9
  2. package/dist/config.js +0 -23
  3. package/dist/instructions.d.ts +1 -1
  4. package/dist/instructions.js +58 -22
  5. package/dist/tools/apps/rewards-catalog/handlers.js +2 -1
  6. package/dist/tools/campaign/index.d.ts +16 -3
  7. package/dist/tools/campaign/index.js +15 -4
  8. package/dist/tools/campaign/member-handlers.d.ts +12 -0
  9. package/dist/tools/campaign/member-handlers.js +33 -0
  10. package/dist/tools/campaign/schemas.d.ts +6 -0
  11. package/dist/tools/campaign/schemas.js +6 -0
  12. package/dist/tools/channel/handlers.d.ts +32 -0
  13. package/dist/tools/channel/handlers.js +130 -0
  14. package/dist/tools/channel/index.d.ts +68 -0
  15. package/dist/tools/channel/index.js +59 -0
  16. package/dist/tools/channel/schemas.d.ts +29 -0
  17. package/dist/tools/channel/schemas.js +30 -0
  18. package/dist/tools/context/handlers.d.ts +49 -0
  19. package/dist/tools/context/handlers.js +131 -0
  20. package/dist/tools/context/index.d.ts +15 -0
  21. package/dist/tools/context/index.js +20 -0
  22. package/dist/tools/context/schemas.d.ts +7 -0
  23. package/dist/tools/context/schemas.js +4 -0
  24. package/dist/tools/group-of-values/handlers.d.ts +39 -0
  25. package/dist/tools/group-of-values/handlers.js +133 -0
  26. package/dist/tools/group-of-values/index.d.ts +82 -0
  27. package/dist/tools/group-of-values/index.js +72 -0
  28. package/dist/tools/group-of-values/schemas.d.ts +36 -0
  29. package/dist/tools/group-of-values/schemas.js +39 -0
  30. package/dist/tools/index.js +12 -0
  31. package/dist/tools/language/handlers.d.ts +24 -0
  32. package/dist/tools/language/handlers.js +127 -0
  33. package/dist/tools/language/index.d.ts +64 -0
  34. package/dist/tools/language/index.js +60 -0
  35. package/dist/tools/language/schemas.d.ts +25 -0
  36. package/dist/tools/language/schemas.js +25 -0
  37. package/dist/tools/member/handlers.d.ts +4 -0
  38. package/dist/tools/member/handlers.js +27 -0
  39. package/dist/tools/member/index.d.ts +14 -2
  40. package/dist/tools/member/index.js +15 -2
  41. package/dist/tools/points/fraud-handlers.d.ts +21 -0
  42. package/dist/tools/points/fraud-handlers.js +96 -0
  43. package/dist/tools/points/index.d.ts +50 -1
  44. package/dist/tools/points/index.js +45 -2
  45. package/dist/tools/points/schemas.d.ts +11 -0
  46. package/dist/tools/points/schemas.js +11 -0
  47. package/dist/tools/reward/category-handlers.d.ts +27 -0
  48. package/dist/tools/reward/category-handlers.js +70 -0
  49. package/dist/tools/reward/handlers.d.ts +0 -12
  50. package/dist/tools/reward/handlers.js +0 -28
  51. package/dist/tools/reward/index.d.ts +76 -3
  52. package/dist/tools/reward/index.js +63 -4
  53. package/dist/tools/reward/photo-handlers.d.ts +10 -0
  54. package/dist/tools/reward/photo-handlers.js +97 -0
  55. package/dist/tools/reward/redemption-handlers.d.ts +23 -0
  56. package/dist/tools/reward/redemption-handlers.js +50 -0
  57. package/dist/tools/reward/schemas.d.ts +31 -0
  58. package/dist/tools/reward/schemas.js +33 -0
  59. package/dist/tools/segment/handlers.js +14 -10
  60. package/dist/tools/segment/index.js +1 -1
  61. package/dist/tools/segment/schemas.js +3 -3
  62. package/dist/tools/store/handlers.d.ts +24 -0
  63. package/dist/tools/store/handlers.js +29 -1
  64. package/dist/tools/store/index.d.ts +41 -3
  65. package/dist/tools/store/index.js +27 -4
  66. package/dist/tools/store/schemas.d.ts +24 -0
  67. package/dist/tools/store/schemas.js +24 -0
  68. package/package.json +2 -12
  69. package/dist/auth/provider.d.ts +0 -33
  70. package/dist/auth/provider.js +0 -383
  71. package/dist/auth/storage.d.ts +0 -16
  72. package/dist/auth/storage.js +0 -120
  73. package/dist/http.d.ts +0 -2
  74. package/dist/http.js +0 -319
package/dist/config.d.ts CHANGED
@@ -13,15 +13,6 @@ declare const ConfigSchema: z.ZodObject<{
13
13
  defaultStoreCode?: string | undefined;
14
14
  }>;
15
15
  export type Config = z.infer<typeof ConfigSchema>;
16
- /**
17
- * Runs a function with a request-scoped config override (OAuth mode).
18
- * This is thread-safe - concurrent requests each have their own isolated config.
19
- */
20
- export declare function runWithConfig<T>(override: {
21
- apiUrl: string;
22
- apiToken: string;
23
- storeCode: string;
24
- }, fn: () => T | Promise<T>): T | Promise<T>;
25
16
  /**
26
17
  * Gets the store code, falling back to default from config if not provided.
27
18
  * Throws a clear error if no store code is available from either source.
package/dist/config.js CHANGED
@@ -1,25 +1,10 @@
1
1
  import { z } from "zod";
2
- import { AsyncLocalStorage } from "async_hooks";
3
2
  const ConfigSchema = z.object({
4
3
  apiUrl: z.string().url(),
5
4
  apiToken: z.string().min(1),
6
5
  defaultStoreCode: z.string().min(1).optional(),
7
6
  });
8
7
  let config = null;
9
- // Request-scoped config storage using AsyncLocalStorage (thread-safe for concurrent requests)
10
- const configStorage = new AsyncLocalStorage();
11
- /**
12
- * Runs a function with a request-scoped config override (OAuth mode).
13
- * This is thread-safe - concurrent requests each have their own isolated config.
14
- */
15
- export function runWithConfig(override, fn) {
16
- const requestConfig = {
17
- apiUrl: override.apiUrl,
18
- apiToken: override.apiToken,
19
- defaultStoreCode: override.storeCode,
20
- };
21
- return configStorage.run(requestConfig, fn);
22
- }
23
8
  /**
24
9
  * Gets the store code, falling back to default from config if not provided.
25
10
  * Throws a clear error if no store code is available from either source.
@@ -38,17 +23,9 @@ export function getStoreCode(storeCode) {
38
23
  export function isConfigured() {
39
24
  if (config)
40
25
  return true;
41
- const requestConfig = configStorage.getStore();
42
- if (requestConfig)
43
- return true;
44
26
  return !!(process.env.OPENLOYALTY_API_URL && process.env.OPENLOYALTY_API_TOKEN);
45
27
  }
46
28
  export function getConfig() {
47
- // Return request-scoped config if set (OAuth mode)
48
- const requestConfig = configStorage.getStore();
49
- if (requestConfig) {
50
- return requestConfig;
51
- }
52
29
  if (config) {
53
30
  return config;
54
31
  }
@@ -2,4 +2,4 @@
2
2
  * MCP Server Instructions - provides context and guidance for AI agents
3
3
  * using the Open Loyalty MCP server.
4
4
  */
5
- export declare const SERVER_INSTRUCTIONS = "\nOpen Loyalty MCP Server - Complete Loyalty Program Management\n\n## Connection & Configuration\n- API URL and API Key are PRE-CONFIGURED via server settings. NEVER ask the user for these values.\n- Store code may be pre-configured. If it is, the storeCode parameter on tools is auto-filled \u2014 do NOT prompt for it.\n- If no default store code is configured, ask the user which store to use at the START of the conversation (use ol_store_list to show options), then pass storeCode on all subsequent tool calls.\n- If the user wants to switch stores mid-conversation, they will tell you explicitly \u2014 only then change the storeCode parameter.\n\n## Domain Model\n\nMember (loyalty program participant)\n \u2514\u2500\u2500 Points (wallet balance, transfers)\n \u2514\u2500\u2500 Tier (current level: Bronze, Silver, Gold)\n \u2514\u2500\u2500 Transactions (purchase history)\n \u2514\u2500\u2500 Rewards (redeemed coupons)\n \u2514\u2500\u2500 Achievements (gamification progress)\n \u2514\u2500\u2500 Badges (visual rewards from achievements)\n\nTierSet (loyalty program structure)\n \u2514\u2500\u2500 Conditions (criteria: activeUnits, totalSpending)\n \u2514\u2500\u2500 Tiers (levels with thresholds)\n\nWalletType (points currency configuration)\n\nReward (redeemable items)\n \u2514\u2500\u2500 Categories (reward groupings)\n\nCampaign (automated points/rewards rules)\n \u2514\u2500\u2500 Type (earning, spending, custom, instant_reward)\n \u2514\u2500\u2500 Trigger (transaction, custom_event, points_transfer)\n \u2514\u2500\u2500 Rules (SKU, category, transaction amount conditions)\n \u2514\u2500\u2500 Effects (give_points, multiply_points, percentage_discount)\n \u2514\u2500\u2500 Targeting (segments, tiers for audience)\n\nSegment (member audience grouping)\n \u2514\u2500\u2500 Parts (groups of criteria - OR logic between parts)\n \u2514\u2500\u2500 Criteria (conditions - AND logic within part)\n Types: transaction_count (working; requires min+max). Other types may be rejected by the API.\n\nAchievement (gamification goals)\n \u2514\u2500\u2500 Trigger (transaction, custom_event, points_transfer, reward_redemption, referral, achievement, tier_change, profile_update)\n \u2514\u2500\u2500 CompleteRule (periodGoal, period type, unique counting)\n \u2514\u2500\u2500 Badge (visual reward when completed)\n\nBadge (visual recognition)\n \u2514\u2500\u2500 Linked to achievements via badgeTypeId\n \u2514\u2500\u2500 Auto-created when referenced by achievement\n\n## Key Workflows\n\n### 1. Create Multi-tier Loyalty Program:\nCRITICAL CONCEPT: A tier set is a CONTAINER that holds ALL tiers (Bronze/Silver/Gold/etc).\n- Create exactly ONE tier set\n- Add ALL tiers to it in ONE call to tierset_update_tiers\n- DO NOT create multiple tier sets for different tiers!\n\nRECOMMENDED WORKFLOW:\n1. wallet_type_list \u2192 Get wallet code (usually \"default\")\n2. tierset_list \u2192 Check if tier set already exists\n3. IF EXISTS: tierset_get \u2192 Get conditionId from existing tier set\n ELSE: tierset_create \u2192 Create ONE tier set, then tierset_get to get conditionId\n4. tierset_update_tiers \u2192 Define ALL tier thresholds in ONE call:\n tiers: [\n { name: \"Bronze\", conditions: [{ conditionId: \"xxx\", value: 0 }] },\n { name: \"Silver\", conditions: [{ conditionId: \"xxx\", value: 500 }] },\n { name: \"Gold\", conditions: [{ conditionId: \"xxx\", value: 1000 }] },\n { name: \"Platinum\", conditions: [{ conditionId: \"xxx\", value: 2000 }] }\n ]\n5. tierset_get_tiers \u2192 Verify tiers created correctly\n\nGOTCHA - Valid tier condition attributes:\n- activeUnits (current spendable balance)\n- totalEarnedUnits (lifetime points - NOT 'earnedUnits'!)\n- totalSpending (lifetime spend amount)\n- monthsSinceJoiningProgram (tenure in months)\n\nCOMMON MISTAKE: Using 'earnedUnits' will fail - use 'totalEarnedUnits' for lifetime points.\n\n### 2. Register and Reward Member:\nmember_create \u2192 points_add (welcome bonus) \u2192 member_get (verify)\n\n### 3. Record Purchase and Earn Points:\ntransaction_create (with customerData) \u2192 triggers campaigns \u2192 points auto-added\n\n### 4. Redeem Reward:\nreward_list \u2192 reward_buy (deducts points) \u2192 reward_redeem (mark coupon used)\n\n### 5. Assign Unmatched Transaction:\ntransaction_list (matched=false) \u2192 transaction_assign_member \u2192 points earned\n\n### 6. Check Member Tier Progress:\nmember_get_tier_progress \u2192 shows current tier, next tier, progress %\n\n### 7. Double Points for VIP Members:\nsegment_create (with transaction_count criteria) \u2192 campaign_create (targeting that segment with give_points effect and pointsRule: \"transaction.grossValue * 2\")\n\n### 8. Purchase Achievement with Badge:\nbadge_list (find or note badgeTypeId) \u2192 achievement_create (type+trigger+aggregation+period required, badgeTypeId)\n\n### 9. Create Targeted Promotion:\nsegment_create (define audience) \u2192 campaign_create (type: earning, target: segment, segmentIds: [segmentId])\n\n### 10. Track Member Gamification:\nachievement_list_member_achievements \u2192 badge_get_member_badges \u2192 achievement_get_member_progress\n\n## Discovery Paths:\n- Members: member_list \u2192 member_get \u2192 points_get_balance\n- Tiers: tierset_list \u2192 tierset_get \u2192 tierset_get_tiers\n- Rewards: reward_category_list \u2192 reward_list \u2192 reward_get\n- Transactions: transaction_list \u2192 transaction_get\n- Campaigns: campaign_list \u2192 campaign_get \u2192 campaign_simulate\n- Segments: segment_list \u2192 segment_get \u2192 segment_get_members \u2192 campaign_create (audience targeting)\n- Achievements: achievement_list \u2192 badge_list \u2192 achievement_create (with badge)\n- Member Gamification: achievement_list_member_achievements \u2192 badge_get_member_badges\n\n## Important Patterns:\n- TIER SET = CONTAINER: One tier set holds ALL tiers (Bronze/Silver/Gold/etc)\n - Create ONE tier set, add ALL tiers in ONE tierset_update_tiers call\n - DO NOT create multiple tier sets for different tiers!\n- TIER SETUP: conditionId REQUIRED for tier thresholds\n 1. tierset_create returns conditions but you need the id from tierset_get\n 2. The conditionId is in tierset_get response: conditions[].id (this IS the conditionId)\n 3. Use the SAME conditionId for ALL tiers in tierset_update_tiers\n- TIER ATTRIBUTES: Use 'totalEarnedUnits' (NOT 'earnedUnits') for lifetime points\n- walletType uses CODE (e.g., 'default'), not UUID\n- Points operations: check balance with points_get_balance before spending\n- Reward flow: reward_buy returns couponCode, use reward_redeem to mark used\n- Transactions auto-match to members via customerData (email, phone, loyaltyCardNumber)\n\n### Pagination:\n- Traditional pagination: use page + perPage params\n- Cursor pagination: provide cursor from previous response for efficient deep pagination\n- Cursor-enabled tools: member_list, transaction_list, points_get_history\n- First scroll request: cursor=\"\" (empty string)\n- Subsequent requests: use cursor value from previous response\n- When cursor provided, page param is ignored\n\n### Campaign Patterns:\n- Campaign types: direct (standard), referral (referral programs)\n- Triggers: transaction (purchase), custom_event, time, achievement, etc.\n- Effects: give_points, give_reward, deduct_unit\n- Target campaigns to segments or tiers using audience.target: \"segment\" and audience.segments array\n- campaign_create requires activity.startsAt, rules[].name, and effects[].effect (use key effect, not type). pointsRule is a STRING expression.\n\n### Points Expression (pointsRule):\npointsRule is a STRING expression, not an object. Examples:\n- Fixed: \"100\"\n- Per dollar: \"transaction.grossValue * 10\"\n- Category-based: \"transaction.category('electronics').grossValue * 5\"\n- Capped: \"(transaction.grossValue * 2 >= 100) ? 100 : transaction.grossValue * 2\"\n- Rounded: \"round_up(0.1 * transaction.grossValue)\"\n\n### Segment Patterns:\n- Parts use OR logic (member matches ANY part)\n- Criteria within a part use AND logic (member must match ALL criteria in that part)\n- Common criteria: transaction_count (working; requires min+max). Other criteria may be rejected by the API.\n\n### Achievement Patterns:\n- Triggers: transaction, custom_event, points_transfer, reward_redemption, referral, achievement, tier_change, profile_update\n- periodGoal sets the target (e.g., 5 purchases, 1000 points spent)\n- period.type defines timeframe: day, week, month, year, last_day, calendarDays, calendarWeeks, calendarMonths, calendarYears\n- aggregation.type defines counting method: quantity (count events only)\n- Link to badge via badgeTypeId - badge auto-created if doesn't exist\n- uniqueAttribute for counting distinct values (e.g., unique products)\n\n### Achievement Period Types:\n- \"day\": Count all-time when consecutive=1\n- \"week\": Count per week (use consecutive=1 for all-time weekly tracking)\n- \"month\": Count per month\n- \"year\": Count per year\n- \"last_day\": Rolling window of N days (e.g., value: 7 for last 7 days)\n- \"calendarDays\": Reset daily at midnight\n- \"calendarWeeks\": Reset weekly (Monday)\n- \"calendarMonths\": Reset monthly (1st of month)\n- \"calendarYears\": Reset yearly (January 1st)\n\n### Streak Achievement Example (7-day login streak):\n{\n \"rules\": [{\n \"trigger\": \"custom_event\",\n \"event\": \"app_login\",\n \"type\": \"direct\",\n \"aggregation\": {\"type\": \"quantity\"},\n \"completeRule\": {\n \"periodGoal\": 1,\n \"period\": {\"type\": \"last_day\", \"value\": 7, \"consecutive\": 1}\n },\n \"limit\": {\n \"interval\": {\"type\": \"calendarDays\", \"value\": 1},\n \"value\": 1\n }\n }]\n}\n\n### Custom Event Workflows:\n\n#### Create Custom Event Campaign:\n1. custom_event_schema_list \u2192 Check if event type exists\n2. custom_event_schema_create (if needed) \u2192 Define event type and fields\n3. campaign_create with trigger: \"custom_event\", event: \"{event_type}\"\n4. Send events via custom_event_send to trigger campaign\n\n#### Create Achievement with Custom Event:\n1. custom_event_schema_create \u2192 Define event (e.g., \"location_visit\")\n2. achievement_create with:\n - rules[].trigger: \"custom_event\"\n - rules[].event: \"{event_type}\"\n - rules[].type: \"direct\"\n - rules[].aggregation.type: \"quantity\"\n - rules[].completeRule.periodGoal: {count}\n - rules[].completeRule.period: { type: \"day\", consecutive: 1 } (all-time)\n\n#### Create Campaign Triggered by Achievement:\n1. achievement_create \u2192 Get achievementId from response\n2. campaign_create with:\n - trigger: \"achievement\"\n - achievementId: \"{achievement_id}\"\n - rules with effects (give_points, give_reward)\n\n### Condition Operators (for campaigns/achievements):\n- is_equal, is_not_equal\n- gte, gt, lte, lt\n- is_between, is_not_between\n- is_time_between\n- is_day_of_week, is_day_of_month\n- contains, not_contains\n- starts_with, ends_with\n- one_of, not_one_of\n- expression (for custom logic)\n\n## Common Campaign Patterns (Industry-Agnostic)\n\nThese patterns work for any loyalty program - retail, QSR, aviation, fan engagement, hospitality, etc.\n\n### Pattern 1: Count Events Toward Goal (Achievements)\nUse case: Track member actions (visits, purchases, logins, check-ins) toward a milestone.\n1. custom_event_schema_create \u2192 Define your action type (e.g., \"store_visit\", \"app_login\")\n2. achievement_create with:\n - trigger: \"custom_event\"\n - event: \"{your_event_code}\"\n - aggregation: { type: \"quantity\" }\n - completeRule: { periodGoal: {count}, period: { type: \"day\", consecutive: 1 } }\n3. custom_event_send to log each action\n\n### Pattern 2: Points Per Action (Instant Rewards)\nUse case: Award instant points for each qualifying action.\n1. custom_event_schema_create (if not using transaction)\n2. campaign_create with:\n - trigger: \"custom_event\" (or \"transaction\")\n - event: \"{event_code}\" (for custom events)\n - rules: [{ effects: [{ effect: \"give_points\", pointsRule: \"50\" }] }]\n\n### Pattern 3: Conditional Rewards (Bonus Conditions)\nUse case: Award points only when a condition is met (e.g., early arrival, large purchase).\nUse ternary expressions in pointsRule instead of conditions array:\n- pointsRule: \"event.body.minutes_before >= 60 ? 25 : 0\"\n- pointsRule: \"transaction.grossValue >= 100 ? 50 : 0\"\n\n### Pattern 4: Execution Limits (Anti-Fraud)\nUse case: Limit rewards to prevent abuse (once per day, once per week).\nCampaign limits structure:\n{\n \"limits\": {\n \"executionsPerMember\": {\n \"value\": 1,\n \"interval\": { \"type\": \"calendarDays\", \"value\": 1 }\n }\n }\n}\nNote: Use \"calendarDays\" (not \"days\"), \"calendarWeeks\", \"calendarMonths\", \"calendarYears\".\nOmit interval entirely for lifetime/forever limit.\n\n### Pattern 5: Achievement-Triggered Bonus\nUse case: Award bonus points/rewards when member completes an achievement.\n1. achievement_create \u2192 Get achievementId from response\n2. campaign_create with:\n - trigger: \"achievement\"\n - achievementId: \"{achievement_id}\"\n - rules with give_points or give_reward effect\n\n### Pattern 6: Tiered Milestones\nUse case: Multiple achievement levels (bronze/silver/gold, 5/10/25 visits).\nCreate multiple achievements with increasing periodGoal values,\neach linked to a different bonus campaign with increasing rewards.\n\n### Pattern 7: Time-Limited Promotion\nUse case: Seasonal or promotional campaigns.\n{\n \"activity\": {\n \"startsAt\": \"2026-01-01 00:00+00:00\",\n \"endsAt\": \"2026-03-31 23:59+00:00\"\n }\n}\n\n### Pattern 8: Streak Tracking\nUse case: Reward consecutive daily/weekly actions (login streaks, workout streaks).\nAchievement with:\n- completeRule.period: { type: \"last_day\", value: 7 } (rolling 7-day window)\n- limit: { value: 1, interval: { type: \"calendarDays\", value: 1 } } (max 1 per day)\n\n## Phase 3: Analytics, Admin, Roles & Stores\n\n### Domain Model (Extended)\n\nAdmin (system user)\n \u2514\u2500\u2500 Roles (permission sets)\n \u2514\u2500\u2500 Permissions (resource + access level)\n \u2514\u2500\u2500 API Keys (programmatic access)\n\nStore (multi-tenant container)\n \u2514\u2500\u2500 Members, Campaigns, Rewards (isolated per store)\n\nAudit Log (compliance tracking)\n \u2514\u2500\u2500 eventType, entityType, entityId, username, timestamp\n\n### Analytics Workflows:\n\n#### 11. Get Program Overview:\nanalytics_dashboard \u2192 analytics_tiers \u2192 analytics_members\n\n#### 12. Analyze Points Economy:\nanalytics_points \u2192 analytics_units (per wallet) \u2192 points_get_histogram\n\n#### 13. Measure Campaign Performance:\nanalytics_campaigns \u2192 analytics_campaign_detail (specific campaign)\n\n#### 14. Track Transactions:\nanalytics_transactions \u2192 transaction_list (details)\n\n### Aggregation Queries (Top Spenders, Purchase Analysis):\n\nIMPORTANT: For queries like \"top 5 spenders in July 2025\", use this approach:\n\n#### 15. Find Top Spenders by Date Range:\n1. transaction_list(purchasedAtFrom, purchasedAtTo, perPage=50, cursor='') - returns customerId with each transaction\n2. Use cursor pagination to fetch ALL pages - even if there are 1000+ transactions\n3. Aggregate grossValue by customerId in your code\n4. Sort by total spent, take top N\n5. member_get for each top spender to get names/details\n\nCRITICAL - DO NOT TRY TO BE SMART OR OPTIMIZE:\n- ALWAYS iterate through ALL pages using cursor pagination - this is the ONLY correct approach\n- DO NOT skip pages or try to sample data - you will get inaccurate results\n- DO NOT use transaction_get individually - transaction_list already includes customerId\n- DO NOT try to find \"smarter\" analytics endpoints - they don't exist for per-customer aggregation\n- Large datasets (1000+ transactions) are normal - just keep paginating until cursor is empty\n- Start with cursor='' (empty string), use returned cursor for next request, repeat until done\n\nExample: Top 5 spenders July 2025\n- First request: transaction_list(purchasedAtFrom: \"2025-07-01\", purchasedAtTo: \"2025-07-31\", perPage: 50, cursor: \"\")\n- Each result includes: transactionId, grossValue, customerId, purchasedAt\n- Keep fetching with returned cursor until response has no cursor or empty transactions\n- Even if there are 1500 transactions (30 pages), iterate through ALL of them\n- Group by customerId, sum grossValue, sort descending, take 5\n\n### Admin & Security Workflows:\n\n#### 15. Create Admin with Limited Role:\nacl_get_resources \u2192 role_create \u2192 admin_create (with roleId)\n\n#### 16. Generate API Key for Integration:\nadmin_get \u2192 apikey_create \u2192 SAVE TOKEN IMMEDIATELY (shown once!)\n\n#### 17. Audit User Actions:\naudit_list (filter by username/entity) \u2192 audit_export (compliance report)\n\n### Store Multi-Tenancy:\n\n#### 18. Create New Store:\nstore_create \u2192 configure campaigns/tiers \u2192 member_create (with storeCode)\n\n### Analytics Query Patterns:\n- All analytics tools support dateFrom/dateTo ISO date filters\n- analytics_dashboard: high-level program metrics\n- analytics_units: wallet-specific metrics (requires walletTypeCode)\n- analytics_campaign_detail: detailed metrics for single campaign\n\n### Admin \u2192 Role \u2192 Permission Model:\n\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Admin \u2502\u2500\u2500\u2500\u2500\u25B6\u2502 Role \u2502\u2500\u2500\u2500\u2500\u25B6\u2502 Permission \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n \u2502 \u2502\n \u2502 resource + access\n \u2502 (VIEW, MODIFY, etc.)\n \u25BC\n\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 API Key \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n### Store Multi-Tenancy:\n- Each store is isolated: members, campaigns, rewards, transactions\n- storeCode is auto-configured from server settings \u2014 NEVER ask the user for it\n- Only pass storeCode if the user explicitly requests a different store\n\n## Phase 4: Webhooks, Import & Export\n\n### Domain Model (Extended)\n\nWebhook Subscription (event notification)\n \u2514\u2500\u2500 eventName (event to subscribe to)\n \u2514\u2500\u2500 url (callback endpoint)\n \u2514\u2500\u2500 headers (custom HTTP headers)\n\nImport (bulk data upload)\n \u2514\u2500\u2500 type: member, groupValue, segmentMembers, unitTransferAdding, etc.\n \u2514\u2500\u2500 status: pending, processing, succeed, failed\n \u2514\u2500\u2500 items (individual row results)\n\nExport (bulk data download)\n \u2514\u2500\u2500 type: campaignCode, member, memberTier, memberSegment, rewardFulfillment\n \u2514\u2500\u2500 status: pending, done, failed, error\n \u2514\u2500\u2500 CSV file (when status='done')\n\n### Webhook Workflows:\n\n#### 19. Subscribe to Member Events for CRM Sync:\nwebhook_events \u2192 webhook_create (eventName: 'member.created', url: 'https://crm.example.com/webhook')\n\n#### 20. List and Manage Subscriptions:\nwebhook_list \u2192 webhook_get \u2192 webhook_update or webhook_delete\n\n### Import Workflows:\n\n#### 21. Bulk Import Members from CSV:\nimport_create (type: 'member', fileContent: CSV data) \u2192 import_list \u2192 import_get (check status)\n\n#### 22. Bulk Add Points to Members:\nimport_create (type: 'unitTransferAdding', fileContent: CSV) \u2192 poll import_get until complete\n\n### Export Workflows:\n\n#### 23. Export Campaign Codes:\nexport_create (type: 'campaignCode', filters: { campaignId }) \u2192 poll export_get (until status='done') \u2192 export_download\n\n#### 24. Export Member Data:\nexport_create (type: 'member') \u2192 export_get \u2192 export_download (returns CSV)\n\n### Webhook Patterns:\n- Use webhook_events to discover available event types before subscribing\n- API uses wrapper: { webhookSubscription: { eventName, url, headers? } }\n- Common events: member.created, member.updated, transaction.created, reward.purchased\n\n### Import Patterns:\n- Import is async: create returns importId, poll status with import_get\n- CSV format required - provide plain text, not base64\n- Types: member, groupValue, segmentMembers, unitTransferAdding, unitTransferSpending, transaction, campaignCode, rewardCoupon\n\n### Export Patterns:\n- Export is async: create returns exportId, poll status until 'done'\n- API body wrapper varies by type: { campaignCode: { filters... } }\n- Only call export_download when status='done'\n- Types: campaignCode, member, memberTier, memberSegment, rewardFulfillment\n";
5
+ export declare const SERVER_INSTRUCTIONS = "\nOpen Loyalty MCP Server - Complete Loyalty Program Management\n\n## Starting a Session\nCall ol_context_get FIRST at the start of every session.\nThis returns wallet types, tier sets (with tier levelIds), active segments, active campaigns, active rewards, and reward categories in a single call.\nIt surfaces IDs for targeting, prevents duplicate creation, and replaces 5+ individual discovery calls.\nExample: Use tierSets[].tiers[].levelId for reward tier targeting, activeSegments[].segmentId for campaign audience targeting.\n\n## Connection & Configuration\n- API URL and API Key are PRE-CONFIGURED via server settings. NEVER ask the user for these values.\n- Store code may be pre-configured. If it is, the storeCode parameter on tools is auto-filled \u2014 do NOT prompt for it.\n- If no default store code is configured, ask the user which store to use at the START of the conversation (use ol_store_list to show options), then pass storeCode on all subsequent tool calls.\n- If the user wants to switch stores mid-conversation, they will tell you explicitly \u2014 only then change the storeCode parameter.\n\n## Domain Model\n\nMember (loyalty program participant)\n \u2514\u2500\u2500 Points (wallet balance, transfers)\n \u2514\u2500\u2500 Tier (current level: Bronze, Silver, Gold)\n \u2514\u2500\u2500 Transactions (purchase history)\n \u2514\u2500\u2500 Rewards (redeemed coupons)\n \u2514\u2500\u2500 Achievements (gamification progress)\n \u2514\u2500\u2500 Badges (visual rewards from achievements)\n\nTierSet (loyalty program structure)\n \u2514\u2500\u2500 Conditions (criteria: activeUnits, totalSpending)\n \u2514\u2500\u2500 Tiers (levels with thresholds)\n\nWalletType (points currency configuration)\n\nReward (redeemable items)\n \u2514\u2500\u2500 Categories (reward groupings)\n\nCampaign (automated points/rewards rules)\n \u2514\u2500\u2500 Type (earning, spending, custom, instant_reward)\n \u2514\u2500\u2500 Trigger (transaction, custom_event, points_transfer)\n \u2514\u2500\u2500 Rules (SKU, category, transaction amount conditions)\n \u2514\u2500\u2500 Effects (give_points, multiply_points, percentage_discount)\n \u2514\u2500\u2500 Targeting (segments, tiers for audience)\n\nSegment (member audience grouping)\n \u2514\u2500\u2500 Parts (groups of criteria - OR logic between parts)\n \u2514\u2500\u2500 Criteria (conditions - AND logic within part)\n Types: transaction_count, average_transaction_value, transaction_amount,\n transaction_percent_in_period, purchase_in_period, bought_skus, bought_labels,\n bought_makers, customer_list, anniversary, last_purchase_n_days_before,\n customer_has_labels, customer_with_labels_values\n\nAchievement (gamification goals)\n \u2514\u2500\u2500 Trigger (transaction, custom_event, points_transfer, reward_redemption, referral, achievement, tier_change, profile_update)\n \u2514\u2500\u2500 CompleteRule (periodGoal, period type, unique counting)\n \u2514\u2500\u2500 Badge (visual reward when completed)\n\nBadge (visual recognition)\n \u2514\u2500\u2500 Linked to achievements via badgeTypeId\n \u2514\u2500\u2500 Auto-created when referenced by achievement\n\n## Key Workflows\n\n### 1. Create Multi-tier Loyalty Program:\nCRITICAL CONCEPT: A tier set is a CONTAINER that holds ALL tiers (Bronze/Silver/Gold/etc).\n- Create exactly ONE tier set\n- Add ALL tiers to it in ONE call to tierset_update_tiers\n- DO NOT create multiple tier sets for different tiers!\n\nRECOMMENDED WORKFLOW:\n1. wallet_type_list \u2192 Get wallet code (usually \"default\")\n2. tierset_list \u2192 Check if tier set already exists\n3. IF EXISTS: tierset_get \u2192 Get conditionId from existing tier set\n ELSE: tierset_create \u2192 Create ONE tier set, then tierset_get to get conditionId\n4. tierset_update_tiers \u2192 Define ALL tier thresholds in ONE call:\n tiers: [\n { name: \"Bronze\", conditions: [{ conditionId: \"xxx\", value: 0 }] },\n { name: \"Silver\", conditions: [{ conditionId: \"xxx\", value: 500 }] },\n { name: \"Gold\", conditions: [{ conditionId: \"xxx\", value: 1000 }] },\n { name: \"Platinum\", conditions: [{ conditionId: \"xxx\", value: 2000 }] }\n ]\n5. tierset_get_tiers \u2192 Verify tiers created correctly\n\nGOTCHA - Valid tier condition attributes:\n- activeUnits (current spendable balance)\n- totalEarnedUnits (lifetime points - NOT 'earnedUnits'!)\n- totalSpending (lifetime spend amount)\n- monthsSinceJoiningProgram (tenure in months)\n\nCOMMON MISTAKE: Using 'earnedUnits' will fail - use 'totalEarnedUnits' for lifetime points.\n\n### 2. Register and Reward Member:\nmember_create \u2192 points_add (welcome bonus) \u2192 member_get (verify)\n\n### 3. Record Purchase and Earn Points:\ntransaction_create (with customerData) \u2192 triggers campaigns \u2192 points auto-added\n\n### 4. Redeem Reward:\nreward_list \u2192 reward_buy (deducts points) \u2192 reward_redeem (mark coupon used)\n\n### 5. Assign Unmatched Transaction:\ntransaction_list (matched=false) \u2192 transaction_assign_member \u2192 points earned\n\n### 6. Check Member Tier Progress:\nmember_get_tier_progress \u2192 shows current tier, next tier, progress %\n\n### 7. Double Points for VIP Members:\nsegment_create (with transaction_count criteria) \u2192 campaign_create (targeting that segment with give_points effect and pointsRule: \"transaction.grossValue * 2\")\n\n### 8. Purchase Achievement with Badge:\nbadge_list (find or note badgeTypeId) \u2192 achievement_create (type+trigger+aggregation+period required, badgeTypeId)\n\n### 9. Create Targeted Promotion:\nsegment_create (define audience) \u2192 campaign_create (type: earning, target: segment, segmentIds: [segmentId])\n\n### 10. Track Member Gamification:\nachievement_list_member_achievements \u2192 badge_get_member_badges \u2192 achievement_get_member_progress\n\n## Discovery Paths:\n- Members: member_list \u2192 member_get \u2192 points_get_balance\n- Tiers: tierset_list \u2192 tierset_get \u2192 tierset_get_tiers\n- Rewards: reward_category_list \u2192 reward_list \u2192 reward_get\n- Transactions: transaction_list \u2192 transaction_get\n- Campaigns: campaign_list \u2192 campaign_get \u2192 campaign_simulate\n- Segments: segment_list \u2192 segment_get \u2192 segment_get_members \u2192 campaign_create (audience targeting)\n- Achievements: achievement_list \u2192 badge_list \u2192 achievement_create (with badge)\n- Member Gamification: achievement_list_member_achievements \u2192 badge_get_member_badges\n\n## Important Patterns:\n- TIER SET = CONTAINER: One tier set holds ALL tiers (Bronze/Silver/Gold/etc)\n - Create ONE tier set, add ALL tiers in ONE tierset_update_tiers call\n - DO NOT create multiple tier sets for different tiers!\n- TIER SETUP: conditionId REQUIRED for tier thresholds\n 1. tierset_create returns conditions but you need the id from tierset_get\n 2. The conditionId is in tierset_get response: conditions[].id (this IS the conditionId)\n 3. Use the SAME conditionId for ALL tiers in tierset_update_tiers\n- TIER ATTRIBUTES: Use 'totalEarnedUnits' (NOT 'earnedUnits') for lifetime points\n- walletType uses CODE (e.g., 'default'), not UUID\n- Points operations: check balance with points_get_balance before spending\n- Reward flow: reward_buy returns couponCode, use reward_redeem to mark used\n- Transactions auto-match to members via customerData (email, phone, loyaltyCardNumber)\n\n### Pagination:\n- Traditional pagination: use page + perPage params\n- Cursor pagination: provide cursor from previous response for efficient deep pagination\n- Cursor-enabled tools: member_list, transaction_list, points_get_history\n- First scroll request: cursor=\"\" (empty string)\n- Subsequent requests: use cursor value from previous response\n- When cursor provided, page param is ignored\n\n### Campaign Patterns:\n- Campaign types: direct (standard), referral (referral programs)\n- Triggers: transaction (purchase), custom_event, time, achievement, etc.\n- Effects: give_points, give_reward, deduct_unit\n- Target campaigns to segments or tiers using audience.target: \"segment\" and audience.segments array\n- campaign_create requires activity.startsAt, rules[].name, and effects[].effect (use key effect, not type). pointsRule is a STRING expression.\n\n### Points Expression (pointsRule):\npointsRule is a STRING expression, not an object. Examples:\n- Fixed: \"100\"\n- Per dollar: \"transaction.grossValue * 10\"\n- Category-based: \"transaction.category('electronics').grossValue * 5\"\n- Capped: \"(transaction.grossValue * 2 >= 100) ? 100 : transaction.grossValue * 2\"\n- Rounded: \"round_up(0.1 * transaction.grossValue)\"\n\n### Points Operations (Fraud & Corrections):\n- ol_points_block: Freeze points from a member's balance (fraud hold). Returns transferId.\n WORKFLOW: ol_points_get_balance \u2192 ol_points_block \u2192 ol_points_unblock (to release)\n- ol_points_unblock(transferId): Release a blocked transfer, returning points to active balance.\n Use ol_points_get_history(type: 'blocked') to find blocked transfer IDs.\n- ol_points_cancel(transferId): Cancel a points transfer (reverses the movement). Use for corrections.\n- ol_points_expire(transferId): Manually expire a points batch before its natural expiry.\n Use ol_points_get_history to find transferIds for cancel/expire operations.\n\n### Member GDPR Operations:\n- ol_member_anonymize: GDPR right-to-erasure. Replaces all PII with anonymous placeholders.\n PRESERVES transaction history and program stats. Distinct from ol_member_delete (hard delete).\n Use anonymize for GDPR requests; use delete only to purge all records entirely.\n\n### Reward Category Management:\n- ol_reward_category_create: Create a new category (name required; sortOrder controls display order).\n- ol_reward_category_update: Update category name, active status, or sort order.\n Use ol_reward_category_list to find categoryId values before updating.\n\n### Member Issued Rewards & Challenges:\n- ol_member_get_issued_rewards: GET /redemption?customerId=X \u2014 member's redeemed rewards (issuedRewardId, name, status, token, costInPoints, rewardType, redemptionDate). Filter by status ('pending','fulfilled','cancelled') or rewardType.\n- ol_member_get_challenge_progress: GET /member/{id}/challenge \u2014 member's challenge progress (milestones, earned rewards).\n\n### Store Settings:\n- ol_store_get_settings: Read program configuration (tier type, wallets, downgrade mode, timezone, etc.). Always call before updating settings.\n- ol_store_update_settings: PATCH settings (partial). Key: tierAssignType ('points'|'transactions'), tierWalletCode, levelDowngradeMode ('none'|'automatic'|'after_x_days'), accountActivationRequired, identificationMethod ('email'|'phone'|'loyaltyCardNumber'), timezone.\n\n### Segment Patterns:\n- Parts use OR logic (member matches ANY part)\n- Criteria within a part use AND logic (member must match ALL criteria in that part)\n- Valid criteria types: transaction_count (requires both min AND max), average_transaction_value,\n transaction_amount, transaction_percent_in_period, purchase_in_period, bought_skus,\n bought_labels, bought_makers, customer_list, anniversary, last_purchase_n_days_before,\n customer_has_labels, customer_with_labels_values\n- transaction_count example: { type: \"transaction_count\", min: 5, max: 999999 } (for \"5 or more purchases\" \u2014 BOTH min and max required; omitting max returns MISSING_MAX_VALUE error)\n\n### Achievement Patterns:\n- Triggers: transaction, custom_event, points_transfer, reward_redemption, referral, achievement, tier_change, profile_update\n- periodGoal sets the target (e.g., 5 purchases, 1000 points spent)\n- period.type defines timeframe: day, week, month, year, last_day, calendarDays, calendarWeeks, calendarMonths, calendarYears\n- aggregation.type defines counting method: quantity (count events only)\n- Link to badge via badgeTypeId - badge auto-created if doesn't exist\n- uniqueAttribute for counting distinct values (e.g., unique products)\n\n### Achievement Period Types:\n- \"day\": Count all-time when consecutive=1\n- \"week\": Count per week (use consecutive=1 for all-time weekly tracking)\n- \"month\": Count per month\n- \"year\": Count per year\n- \"last_day\": Rolling window of N days (e.g., value: 7 for last 7 days)\n- \"calendarDays\": Reset daily at midnight\n- \"calendarWeeks\": Reset weekly (Monday)\n- \"calendarMonths\": Reset monthly (1st of month)\n- \"calendarYears\": Reset yearly (January 1st)\n\n### Streak Achievement Example (7-day login streak):\n{\n \"rules\": [{\n \"trigger\": \"custom_event\",\n \"event\": \"app_login\",\n \"type\": \"direct\",\n \"aggregation\": {\"type\": \"quantity\"},\n \"completeRule\": {\n \"periodGoal\": 1,\n \"period\": {\"type\": \"last_day\", \"value\": 7, \"consecutive\": 1}\n },\n \"limit\": {\n \"interval\": {\"type\": \"calendarDays\", \"value\": 1},\n \"value\": 1\n }\n }]\n}\n\n### Custom Event Workflows:\n\n#### Create Custom Event Campaign:\n1. custom_event_schema_list \u2192 Check if event type exists\n2. custom_event_schema_create (if needed) \u2192 Define event type and fields\n3. campaign_create with trigger: \"custom_event\", event: \"{event_type}\"\n4. Send events via custom_event_send to trigger campaign\n\n#### Create Achievement with Custom Event:\n1. custom_event_schema_create \u2192 Define event (e.g., \"location_visit\")\n2. achievement_create with:\n - rules[].trigger: \"custom_event\"\n - rules[].event: \"{event_type}\"\n - rules[].type: \"direct\"\n - rules[].aggregation.type: \"quantity\"\n - rules[].completeRule.periodGoal: {count}\n - rules[].completeRule.period: { type: \"day\", consecutive: 1 } (all-time)\n\n#### Create Campaign Triggered by Achievement:\n1. achievement_create \u2192 Get achievementId from response\n2. campaign_create with:\n - trigger: \"achievement\"\n - achievementId: \"{achievement_id}\"\n - rules with effects (give_points, give_reward)\n\n### Condition Operators (for campaigns/achievements):\n- is_equal, is_not_equal\n- is_greater_or_equal, is_greater, is_less_or_equal, is_less\n- is_between\n- is_after, is_before\n- contains, not_contains\n- has_at_least_one_label\n- is_one_of\n- starts_with, ends_with\n- matches_regex\n\n## Common Campaign Patterns (Industry-Agnostic)\n\nThese patterns work for any loyalty program - retail, QSR, aviation, fan engagement, hospitality, etc.\n\n### Pattern 1: Count Events Toward Goal (Achievements)\nUse case: Track member actions (visits, purchases, logins, check-ins) toward a milestone.\n1. custom_event_schema_create \u2192 Define your action type (e.g., \"store_visit\", \"app_login\")\n2. achievement_create with:\n - trigger: \"custom_event\"\n - event: \"{your_event_code}\"\n - aggregation: { type: \"quantity\" }\n - completeRule: { periodGoal: {count}, period: { type: \"day\", consecutive: 1 } }\n3. custom_event_send to log each action\n\n### Pattern 2: Points Per Action (Instant Rewards)\nUse case: Award instant points for each qualifying action.\n1. custom_event_schema_create (if not using transaction)\n2. campaign_create with:\n - trigger: \"custom_event\" (or \"transaction\")\n - event: \"{event_code}\" (for custom events)\n - rules: [{ effects: [{ effect: \"give_points\", pointsRule: \"50\" }] }]\n\n### Pattern 3: Conditional Rewards (Bonus Conditions)\nUse case: Award points only when a condition is met (e.g., early arrival, large purchase).\nUse ternary expressions in pointsRule instead of conditions array:\n- pointsRule: \"event.body.minutes_before >= 60 ? 25 : 0\"\n- pointsRule: \"transaction.grossValue >= 100 ? 50 : 0\"\n\n### Pattern 4: Execution Limits (Anti-Fraud)\nUse case: Limit rewards to prevent abuse (once per day, once per week).\nCampaign limits structure:\n{\n \"limits\": {\n \"executionsPerMember\": {\n \"value\": 1,\n \"interval\": { \"type\": \"calendarDays\", \"value\": 1 }\n }\n }\n}\nNote: Use \"calendarDays\" (not \"days\"), \"calendarWeeks\", \"calendarMonths\", \"calendarYears\".\nOmit interval entirely for lifetime/forever limit.\n\n### Pattern 5: Achievement-Triggered Bonus\nUse case: Award bonus points/rewards when member completes an achievement.\n1. achievement_create \u2192 Get achievementId from response\n2. campaign_create with:\n - trigger: \"achievement\"\n - achievementId: \"{achievement_id}\"\n - rules with give_points or give_reward effect\n\n### Pattern 6: Tiered Milestones\nUse case: Multiple achievement levels (bronze/silver/gold, 5/10/25 visits).\nCreate multiple achievements with increasing periodGoal values,\neach linked to a different bonus campaign with increasing rewards.\n\n### Pattern 7: Time-Limited Promotion\nUse case: Seasonal or promotional campaigns.\n{\n \"activity\": {\n \"startsAt\": \"2026-01-01 00:00+00:00\",\n \"endsAt\": \"2026-03-31 23:59+00:00\"\n }\n}\n\n### Pattern 8: Streak Tracking\nUse case: Reward consecutive daily/weekly actions (login streaks, workout streaks).\nAchievement with:\n- completeRule.period: { type: \"last_day\", value: 7 } (rolling 7-day window)\n- limit: { value: 1, interval: { type: \"calendarDays\", value: 1 } } (max 1 per day)\n\n## Phase 3: Analytics, Admin, Roles & Stores\n\n### Domain Model (Extended)\n\nAdmin (system user)\n \u2514\u2500\u2500 Roles (permission sets)\n \u2514\u2500\u2500 Permissions (resource + access level)\n \u2514\u2500\u2500 API Keys (programmatic access)\n\nStore (multi-tenant container)\n \u2514\u2500\u2500 Members, Campaigns, Rewards (isolated per store)\n\nAudit Log (compliance tracking)\n \u2514\u2500\u2500 eventType, entityType, entityId, username, timestamp\n\n### Analytics Workflows:\n\n#### 11. Get Program Overview:\nanalytics_dashboard \u2192 analytics_tiers \u2192 analytics_members\n\n#### 12. Analyze Points Economy:\nanalytics_points \u2192 analytics_units (per wallet) \u2192 points_get_histogram\n\n#### 13. Measure Campaign Performance:\nanalytics_campaigns \u2192 analytics_campaign_detail (specific campaign)\n\n#### 14. Track Transactions:\nanalytics_transactions \u2192 transaction_list (details)\n\n### Aggregation Queries (Top Spenders, Purchase Analysis):\n\nIMPORTANT: For queries like \"top 5 spenders in July 2025\", use this approach:\n\n#### 15. Find Top Spenders by Date Range:\n1. transaction_list(purchasedAtFrom, purchasedAtTo, perPage=50, cursor='') - returns customerId with each transaction\n2. Use cursor pagination to fetch ALL pages - even if there are 1000+ transactions\n3. Aggregate grossValue by customerId in your code\n4. Sort by total spent, take top N\n5. member_get for each top spender to get names/details\n\nCRITICAL: ALWAYS iterate ALL cursor pages \u2014 DO NOT skip or sample data.\n- Start cursor='' (empty), use returned cursor each page until exhausted\n- Aggregate grossValue by customerId in your code; 1000+ transactions is normal \u2014 just keep paginating\n- First request example: transaction_list(purchasedAtFrom: \"2025-07-01\", purchasedAtTo: \"2025-07-31\", perPage: 50, cursor: \"\")\n\n### Admin & Security Workflows:\n\n#### 15. Create Admin with Limited Role:\nacl_get_resources \u2192 role_create \u2192 admin_create (with roleId)\n\n#### 16. Generate API Key for Integration:\nadmin_get \u2192 apikey_create \u2192 SAVE TOKEN IMMEDIATELY (shown once!)\n\n#### 17. Audit User Actions:\naudit_list (filter by username/entity) \u2192 audit_export (compliance report)\n\n### Store Multi-Tenancy:\n\n#### 18. Create New Store:\nstore_create \u2192 configure campaigns/tiers \u2192 member_create (with storeCode)\n\n### Analytics Query Patterns:\n- All analytics tools support dateFrom/dateTo ISO date filters\n- analytics_dashboard: high-level program metrics\n- analytics_units: wallet-specific metrics (requires walletTypeCode)\n- analytics_campaign_detail: detailed metrics for single campaign\n\n### Admin \u2192 Role \u2192 Permission Model:\n\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Admin \u2502\u2500\u2500\u2500\u2500\u25B6\u2502 Role \u2502\u2500\u2500\u2500\u2500\u25B6\u2502 Permission \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n \u2502 \u2502\n \u2502 resource + access\n \u2502 (VIEW, MODIFY, etc.)\n \u25BC\n\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 API Key \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n### Store Multi-Tenancy:\n- Each store is isolated: members, campaigns, rewards, transactions\n- storeCode is auto-configured from server settings \u2014 NEVER ask the user for it\n- Only pass storeCode if the user explicitly requests a different store\n\n## Phase 4: Webhooks, Import & Export\n\n### Domain Model (Extended)\n\nWebhook Subscription (event notification)\n \u2514\u2500\u2500 eventName (event to subscribe to)\n \u2514\u2500\u2500 url (callback endpoint)\n \u2514\u2500\u2500 headers (custom HTTP headers)\n\nImport (bulk data upload)\n \u2514\u2500\u2500 type: member, groupValue, segmentMembers, unitTransferAdding, etc.\n \u2514\u2500\u2500 status: pending, processing, succeed, failed\n \u2514\u2500\u2500 items (individual row results)\n\nExport (bulk data download)\n \u2514\u2500\u2500 type: campaignCode, member, memberTier, memberSegment, rewardFulfillment\n \u2514\u2500\u2500 status: pending, done, failed, error\n \u2514\u2500\u2500 CSV file (when status='done')\n\n### Webhook Workflows:\n\n#### 19. Subscribe to Member Events for CRM Sync:\nwebhook_events \u2192 webhook_create (eventName: 'member.created', url: 'https://crm.example.com/webhook')\n\n#### 20. List and Manage Subscriptions:\nwebhook_list \u2192 webhook_get \u2192 webhook_update or webhook_delete\n\n### Import Workflows:\n\n#### 21. Bulk Import Members from CSV:\nimport_create (type: 'member', fileContent: CSV data) \u2192 import_list \u2192 import_get (check status)\n\n#### 22. Bulk Add Points to Members:\nimport_create (type: 'unitTransferAdding', fileContent: CSV) \u2192 poll import_get until complete\n\n### Export Workflows:\n\n#### 23. Export Campaign Codes:\nexport_create (type: 'campaignCode', filters: { campaignId }) \u2192 poll export_get (until status='done') \u2192 export_download\n\n#### 24. Export Member Data:\nexport_create (type: 'member') \u2192 export_get \u2192 export_download (returns CSV)\n\n### Webhook Patterns:\n- Use webhook_events to discover available event types before subscribing\n- API uses wrapper: { webhookSubscription: { eventName, url, headers? } }\n- Common events: member.created, member.updated, transaction.created, reward.purchased\n\n### Import Patterns:\n- Import is async: create returns importId, poll status with import_get\n- CSV format required - provide plain text, not base64\n- Types: member, groupValue, segmentMembers, unitTransferAdding, unitTransferSpending, transaction, campaignCode, rewardCoupon\n\n### Export Patterns:\n- Export is async: create returns exportId, poll status until 'done'\n- API body wrapper varies by type: { campaignCode: { filters... } }\n- Only call export_download when status='done'\n- Types: campaignCode, member, memberTier, memberSegment, rewardFulfillment\n\n### Channel, Language & Config Patterns:\n- ol_channel_*: Manage sales channels (Mobile App, POS, Web). identifier must be unique per store.\n- ol_language_*: Manage languages. GLOBAL \u2014 no storeCode. Cannot delete default language ('en').\n- ol_group_of_values_*: Manage label value groups and their values. No DELETE for groups (use active: false). Use ol_group_value_add/update/delete for individual values.\n- ol_reward_photo_upload/delete: Attach/remove images from rewards. Provide photoUrl \u2014 handler fetches and uploads. Use ol_reward_get to find existing photoIds for deletion.\n";
@@ -5,6 +5,12 @@
5
5
  export const SERVER_INSTRUCTIONS = `
6
6
  Open Loyalty MCP Server - Complete Loyalty Program Management
7
7
 
8
+ ## Starting a Session
9
+ Call ol_context_get FIRST at the start of every session.
10
+ This returns wallet types, tier sets (with tier levelIds), active segments, active campaigns, active rewards, and reward categories in a single call.
11
+ It surfaces IDs for targeting, prevents duplicate creation, and replaces 5+ individual discovery calls.
12
+ Example: Use tierSets[].tiers[].levelId for reward tier targeting, activeSegments[].segmentId for campaign audience targeting.
13
+
8
14
  ## Connection & Configuration
9
15
  - API URL and API Key are PRE-CONFIGURED via server settings. NEVER ask the user for these values.
10
16
  - Store code may be pre-configured. If it is, the storeCode parameter on tools is auto-filled — do NOT prompt for it.
@@ -40,7 +46,10 @@ Campaign (automated points/rewards rules)
40
46
  Segment (member audience grouping)
41
47
  └── Parts (groups of criteria - OR logic between parts)
42
48
  └── Criteria (conditions - AND logic within part)
43
- Types: transaction_count (working; requires min+max). Other types may be rejected by the API.
49
+ Types: transaction_count, average_transaction_value, transaction_amount,
50
+ transaction_percent_in_period, purchase_in_period, bought_skus, bought_labels,
51
+ bought_makers, customer_list, anniversary, last_purchase_n_days_before,
52
+ customer_has_labels, customer_with_labels_values
44
53
 
45
54
  Achievement (gamification goals)
46
55
  └── Trigger (transaction, custom_event, points_transfer, reward_redemption, referral, achievement, tier_change, profile_update)
@@ -155,10 +164,41 @@ pointsRule is a STRING expression, not an object. Examples:
155
164
  - Capped: "(transaction.grossValue * 2 >= 100) ? 100 : transaction.grossValue * 2"
156
165
  - Rounded: "round_up(0.1 * transaction.grossValue)"
157
166
 
167
+ ### Points Operations (Fraud & Corrections):
168
+ - ol_points_block: Freeze points from a member's balance (fraud hold). Returns transferId.
169
+ WORKFLOW: ol_points_get_balance → ol_points_block → ol_points_unblock (to release)
170
+ - ol_points_unblock(transferId): Release a blocked transfer, returning points to active balance.
171
+ Use ol_points_get_history(type: 'blocked') to find blocked transfer IDs.
172
+ - ol_points_cancel(transferId): Cancel a points transfer (reverses the movement). Use for corrections.
173
+ - ol_points_expire(transferId): Manually expire a points batch before its natural expiry.
174
+ Use ol_points_get_history to find transferIds for cancel/expire operations.
175
+
176
+ ### Member GDPR Operations:
177
+ - ol_member_anonymize: GDPR right-to-erasure. Replaces all PII with anonymous placeholders.
178
+ PRESERVES transaction history and program stats. Distinct from ol_member_delete (hard delete).
179
+ Use anonymize for GDPR requests; use delete only to purge all records entirely.
180
+
181
+ ### Reward Category Management:
182
+ - ol_reward_category_create: Create a new category (name required; sortOrder controls display order).
183
+ - ol_reward_category_update: Update category name, active status, or sort order.
184
+ Use ol_reward_category_list to find categoryId values before updating.
185
+
186
+ ### Member Issued Rewards & Challenges:
187
+ - ol_member_get_issued_rewards: GET /redemption?customerId=X — member's redeemed rewards (issuedRewardId, name, status, token, costInPoints, rewardType, redemptionDate). Filter by status ('pending','fulfilled','cancelled') or rewardType.
188
+ - ol_member_get_challenge_progress: GET /member/{id}/challenge — member's challenge progress (milestones, earned rewards).
189
+
190
+ ### Store Settings:
191
+ - ol_store_get_settings: Read program configuration (tier type, wallets, downgrade mode, timezone, etc.). Always call before updating settings.
192
+ - ol_store_update_settings: PATCH settings (partial). Key: tierAssignType ('points'|'transactions'), tierWalletCode, levelDowngradeMode ('none'|'automatic'|'after_x_days'), accountActivationRequired, identificationMethod ('email'|'phone'|'loyaltyCardNumber'), timezone.
193
+
158
194
  ### Segment Patterns:
159
195
  - Parts use OR logic (member matches ANY part)
160
196
  - Criteria within a part use AND logic (member must match ALL criteria in that part)
161
- - Common criteria: transaction_count (working; requires min+max). Other criteria may be rejected by the API.
197
+ - Valid criteria types: transaction_count (requires both min AND max), average_transaction_value,
198
+ transaction_amount, transaction_percent_in_period, purchase_in_period, bought_skus,
199
+ bought_labels, bought_makers, customer_list, anniversary, last_purchase_n_days_before,
200
+ customer_has_labels, customer_with_labels_values
201
+ - transaction_count example: { type: "transaction_count", min: 5, max: 999999 } (for "5 or more purchases" — BOTH min and max required; omitting max returns MISSING_MAX_VALUE error)
162
202
 
163
203
  ### Achievement Patterns:
164
204
  - Triggers: transaction, custom_event, points_transfer, reward_redemption, referral, achievement, tier_change, profile_update
@@ -224,14 +264,14 @@ pointsRule is a STRING expression, not an object. Examples:
224
264
 
225
265
  ### Condition Operators (for campaigns/achievements):
226
266
  - is_equal, is_not_equal
227
- - gte, gt, lte, lt
228
- - is_between, is_not_between
229
- - is_time_between
230
- - is_day_of_week, is_day_of_month
267
+ - is_greater_or_equal, is_greater, is_less_or_equal, is_less
268
+ - is_between
269
+ - is_after, is_before
231
270
  - contains, not_contains
271
+ - has_at_least_one_label
272
+ - is_one_of
232
273
  - starts_with, ends_with
233
- - one_of, not_one_of
234
- - expression (for custom logic)
274
+ - matches_regex
235
275
 
236
276
  ## Common Campaign Patterns (Industry-Agnostic)
237
277
 
@@ -343,20 +383,10 @@ IMPORTANT: For queries like "top 5 spenders in July 2025", use this approach:
343
383
  4. Sort by total spent, take top N
344
384
  5. member_get for each top spender to get names/details
345
385
 
346
- CRITICAL - DO NOT TRY TO BE SMART OR OPTIMIZE:
347
- - ALWAYS iterate through ALL pages using cursor pagination - this is the ONLY correct approach
348
- - DO NOT skip pages or try to sample data - you will get inaccurate results
349
- - DO NOT use transaction_get individually - transaction_list already includes customerId
350
- - DO NOT try to find "smarter" analytics endpoints - they don't exist for per-customer aggregation
351
- - Large datasets (1000+ transactions) are normal - just keep paginating until cursor is empty
352
- - Start with cursor='' (empty string), use returned cursor for next request, repeat until done
353
-
354
- Example: Top 5 spenders July 2025
355
- - First request: transaction_list(purchasedAtFrom: "2025-07-01", purchasedAtTo: "2025-07-31", perPage: 50, cursor: "")
356
- - Each result includes: transactionId, grossValue, customerId, purchasedAt
357
- - Keep fetching with returned cursor until response has no cursor or empty transactions
358
- - Even if there are 1500 transactions (30 pages), iterate through ALL of them
359
- - Group by customerId, sum grossValue, sort descending, take 5
386
+ CRITICAL: ALWAYS iterate ALL cursor pages — DO NOT skip or sample data.
387
+ - Start cursor='' (empty), use returned cursor each page until exhausted
388
+ - Aggregate grossValue by customerId in your code; 1000+ transactions is normal just keep paginating
389
+ - First request example: transaction_list(purchasedAtFrom: "2025-07-01", purchasedAtTo: "2025-07-31", perPage: 50, cursor: "")
360
390
 
361
391
  ### Admin & Security Workflows:
362
392
 
@@ -455,4 +485,10 @@ export_create (type: 'member') → export_get → export_download (returns CSV)
455
485
  - API body wrapper varies by type: { campaignCode: { filters... } }
456
486
  - Only call export_download when status='done'
457
487
  - Types: campaignCode, member, memberTier, memberSegment, rewardFulfillment
488
+
489
+ ### Channel, Language & Config Patterns:
490
+ - ol_channel_*: Manage sales channels (Mobile App, POS, Web). identifier must be unique per store.
491
+ - ol_language_*: Manage languages. GLOBAL — no storeCode. Cannot delete default language ('en').
492
+ - ol_group_of_values_*: Manage label value groups and their values. No DELETE for groups (use active: false). Use ol_group_value_add/update/delete for individual values.
493
+ - ol_reward_photo_upload/delete: Attach/remove images from rewards. Provide photoUrl — handler fetches and uploads. Use ol_reward_get to find existing photoIds for deletion.
458
494
  `;
@@ -1,4 +1,5 @@
1
- import { rewardList, rewardCategoryList } from "../../reward/handlers.js";
1
+ import { rewardList } from "../../reward/handlers.js";
2
+ import { rewardCategoryList } from "../../reward/category-handlers.js";
2
3
  import { pointsGetBalance } from "../../points/handlers.js";
3
4
  export async function aggregateRewardsCatalog(input) {
4
5
  const { storeCode, memberId, page, perPage = 20 } = input;
@@ -1,9 +1,9 @@
1
- export { CampaignListInputSchema, CampaignGetInputSchema, CampaignCreateInputSchema, CampaignUpdateInputSchema, CampaignPatchInputSchema, CampaignDeleteInputSchema, CampaignSimulateInputSchema, CampaignGenerateCodesInputSchema, CampaignListCodesInputSchema, CampaignGetAvailableInputSchema, CampaignGetVisibleInputSchema, CampaignGetLeaderboardInputSchema, } from "./schemas.js";
1
+ export { CampaignListInputSchema, CampaignGetInputSchema, CampaignCreateInputSchema, CampaignUpdateInputSchema, CampaignPatchInputSchema, CampaignDeleteInputSchema, CampaignSimulateInputSchema, CampaignGenerateCodesInputSchema, CampaignListCodesInputSchema, CampaignGetAvailableInputSchema, CampaignGetVisibleInputSchema, CampaignGetLeaderboardInputSchema, MemberGetChallengeProgressInputSchema, } from "./schemas.js";
2
2
  export type { SimulatedEffect, CampaignCode, MemberCampaignItem, LeaderboardEntry, CampaignSimulateInput, CampaignCreateInput, } from "./types.js";
3
3
  export { campaignList, campaignGet, campaignCreate, campaignUpdate, campaignPatch, campaignDelete, campaignSimulate, } from "./handlers.js";
4
- export { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard, } from "./member-handlers.js";
4
+ export { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard, memberGetChallengeProgress, } from "./member-handlers.js";
5
5
  import { campaignList, campaignGet, campaignCreate, campaignUpdate, campaignPatch, campaignDelete, campaignSimulate } from "./handlers.js";
6
- import { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard } from "./member-handlers.js";
6
+ import { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard, memberGetChallengeProgress } from "./member-handlers.js";
7
7
  export declare const campaignToolDefinitions: readonly [{
8
8
  readonly name: "ol_campaign_list";
9
9
  readonly title: "List Campaigns";
@@ -855,4 +855,17 @@ export declare const campaignToolDefinitions: readonly [{
855
855
  type: import("zod").ZodOptional<import("zod").ZodString>;
856
856
  };
857
857
  readonly handler: typeof campaignGetLeaderboard;
858
+ }, {
859
+ readonly name: "ol_member_get_challenge_progress";
860
+ readonly title: "Get Member Challenge Progress";
861
+ readonly description: string;
862
+ readonly readOnly: true;
863
+ readonly idempotent: true;
864
+ readonly inputSchema: {
865
+ storeCode: import("zod").ZodOptional<import("zod").ZodString>;
866
+ memberId: import("zod").ZodString;
867
+ page: import("zod").ZodOptional<import("zod").ZodNumber>;
868
+ perPage: import("zod").ZodOptional<import("zod").ZodNumber>;
869
+ };
870
+ readonly handler: typeof memberGetChallengeProgress;
858
871
  }];
@@ -1,12 +1,12 @@
1
1
  // Re-export schemas
2
- export { CampaignListInputSchema, CampaignGetInputSchema, CampaignCreateInputSchema, CampaignUpdateInputSchema, CampaignPatchInputSchema, CampaignDeleteInputSchema, CampaignSimulateInputSchema, CampaignGenerateCodesInputSchema, CampaignListCodesInputSchema, CampaignGetAvailableInputSchema, CampaignGetVisibleInputSchema, CampaignGetLeaderboardInputSchema, } from "./schemas.js";
2
+ export { CampaignListInputSchema, CampaignGetInputSchema, CampaignCreateInputSchema, CampaignUpdateInputSchema, CampaignPatchInputSchema, CampaignDeleteInputSchema, CampaignSimulateInputSchema, CampaignGenerateCodesInputSchema, CampaignListCodesInputSchema, CampaignGetAvailableInputSchema, CampaignGetVisibleInputSchema, CampaignGetLeaderboardInputSchema, MemberGetChallengeProgressInputSchema, } from "./schemas.js";
3
3
  // Re-export handlers
4
4
  export { campaignList, campaignGet, campaignCreate, campaignUpdate, campaignPatch, campaignDelete, campaignSimulate, } from "./handlers.js";
5
- export { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard, } from "./member-handlers.js";
5
+ export { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard, memberGetChallengeProgress, } from "./member-handlers.js";
6
6
  // Imports for tool definitions
7
- import { CampaignListInputSchema, CampaignGetInputSchema, CampaignCreateInputSchema, CampaignUpdateInputSchema, CampaignPatchInputSchema, CampaignDeleteInputSchema, CampaignSimulateInputSchema, CampaignGenerateCodesInputSchema, CampaignListCodesInputSchema, CampaignGetAvailableInputSchema, CampaignGetVisibleInputSchema, CampaignGetLeaderboardInputSchema, } from "./schemas.js";
7
+ import { MemberGetChallengeProgressInputSchema, CampaignListInputSchema, CampaignGetInputSchema, CampaignCreateInputSchema, CampaignUpdateInputSchema, CampaignPatchInputSchema, CampaignDeleteInputSchema, CampaignSimulateInputSchema, CampaignGenerateCodesInputSchema, CampaignListCodesInputSchema, CampaignGetAvailableInputSchema, CampaignGetVisibleInputSchema, CampaignGetLeaderboardInputSchema, } from "./schemas.js";
8
8
  import { campaignList, campaignGet, campaignCreate, campaignUpdate, campaignPatch, campaignDelete, campaignSimulate, } from "./handlers.js";
9
- import { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard, } from "./member-handlers.js";
9
+ import { campaignGenerateCodes, campaignListCodes, campaignGetAvailable, campaignGetVisible, campaignGetLeaderboard, memberGetChallengeProgress, } from "./member-handlers.js";
10
10
  // Tool definitions
11
11
  export const campaignToolDefinitions = [
12
12
  {
@@ -137,4 +137,15 @@ export const campaignToolDefinitions = [
137
137
  inputSchema: CampaignGetLeaderboardInputSchema,
138
138
  handler: campaignGetLeaderboard,
139
139
  },
140
+ {
141
+ name: "ol_member_get_challenge_progress",
142
+ title: "Get Member Challenge Progress",
143
+ description: "Get a member's progress on all challenges (challenge-type campaigns). " +
144
+ "Returns challenge details with milestone progress, completion status, and earned rewards. " +
145
+ "Use to answer 'how far is member X in challenge Y?' or 'which challenges has this member completed?'",
146
+ readOnly: true,
147
+ idempotent: true,
148
+ inputSchema: MemberGetChallengeProgressInputSchema,
149
+ handler: memberGetChallengeProgress,
150
+ },
140
151
  ];
@@ -58,3 +58,15 @@ export declare function campaignGetLeaderboard(input: {
58
58
  filtered?: number;
59
59
  };
60
60
  }>;
61
+ export declare function memberGetChallengeProgress(input: {
62
+ storeCode?: string;
63
+ memberId: string;
64
+ page?: number;
65
+ perPage?: number;
66
+ }): Promise<{
67
+ challenges: Array<Record<string, unknown>>;
68
+ total: {
69
+ all?: number;
70
+ filtered?: number;
71
+ };
72
+ }>;
@@ -193,3 +193,36 @@ export async function campaignGetLeaderboard(input) {
193
193
  throw formatApiError(error, "ol_campaign_get_leaderboard");
194
194
  }
195
195
  }
196
+ export async function memberGetChallengeProgress(input) {
197
+ const storeCode = getStoreCode(input.storeCode);
198
+ const params = new URLSearchParams();
199
+ if (input.page)
200
+ params.append("_page", String(input.page));
201
+ if (input.perPage)
202
+ params.append("_itemsOnPage", String(input.perPage));
203
+ const queryString = params.toString();
204
+ const url = `/${storeCode}/member/${input.memberId}/challenge${queryString ? `?${queryString}` : ""}`;
205
+ try {
206
+ const response = await apiGet(url);
207
+ const total = response.total || {};
208
+ return {
209
+ challenges: response.items || [],
210
+ total: {
211
+ all: typeof total.all === "number" ? total.all : undefined,
212
+ filtered: typeof total.filtered === "number" ? total.filtered : undefined,
213
+ },
214
+ };
215
+ }
216
+ catch (error) {
217
+ const axiosError = error;
218
+ if (axiosError.response?.status === 404) {
219
+ throw new OpenLoyaltyError({
220
+ code: "NOT_FOUND",
221
+ message: `Member '${input.memberId}' not found`,
222
+ hint: "Use ol_member_list() to find the member by email, name, or phone.",
223
+ relatedTool: "ol_member_get_challenge_progress",
224
+ });
225
+ }
226
+ throw formatApiError(error, "ol_member_get_challenge_progress");
227
+ }
228
+ }
@@ -765,3 +765,9 @@ export declare const CampaignCreateInputSchema: {
765
765
  event: z.ZodOptional<z.ZodString>;
766
766
  achievementId: z.ZodOptional<z.ZodString>;
767
767
  };
768
+ export declare const MemberGetChallengeProgressInputSchema: {
769
+ storeCode: z.ZodOptional<z.ZodString>;
770
+ memberId: z.ZodString;
771
+ page: z.ZodOptional<z.ZodNumber>;
772
+ perPage: z.ZodOptional<z.ZodNumber>;
773
+ };
@@ -306,3 +306,9 @@ export const CampaignCreateInputSchema = {
306
306
  achievementId: z.string().optional().describe("Achievement ID (required for trigger='achievement'). " +
307
307
  "Use achievement_create first, then pass the returned achievementId here to award points/rewards when members complete that achievement."),
308
308
  };
309
+ export const MemberGetChallengeProgressInputSchema = {
310
+ storeCode: z.string().optional().describe("INTERNAL: Auto-configured from server settings. NEVER ask the user for this value. Only set if the user explicitly requests a different store."),
311
+ memberId: z.string().describe("Member ID (UUID) to retrieve challenge progress for."),
312
+ page: z.number().optional().describe("Page number (default: 1)."),
313
+ perPage: z.number().optional().describe("Items per page (default: 10)."),
314
+ };
@@ -0,0 +1,32 @@
1
+ export declare function channelList(input: {
2
+ storeCode?: string;
3
+ page?: number;
4
+ perPage?: number;
5
+ name?: string;
6
+ identifier?: string;
7
+ }): Promise<Record<string, unknown>>;
8
+ export declare function channelCreate(input: {
9
+ storeCode?: string;
10
+ name: string;
11
+ identifier: string;
12
+ description?: string;
13
+ }): Promise<{
14
+ channelId: string;
15
+ }>;
16
+ export declare function channelGet(input: {
17
+ storeCode?: string;
18
+ channelId: string;
19
+ }): Promise<Record<string, unknown>>;
20
+ export declare function channelUpdate(input: {
21
+ storeCode?: string;
22
+ channelId: string;
23
+ name: string;
24
+ identifier: string;
25
+ description?: string;
26
+ }): Promise<{
27
+ channelId: string;
28
+ }>;
29
+ export declare function channelDelete(input: {
30
+ storeCode?: string;
31
+ channelId: string;
32
+ }): Promise<void>;
@@ -0,0 +1,130 @@
1
+ import { apiGet, apiPost, apiPut, apiDelete } from "../../client/http.js";
2
+ import { formatApiError, OpenLoyaltyError } from "../../utils/errors.js";
3
+ import axios from "axios";
4
+ import { getStoreCode } from "../../config.js";
5
+ export async function channelList(input) {
6
+ const storeCode = getStoreCode(input.storeCode);
7
+ const params = new URLSearchParams();
8
+ if (input.page)
9
+ params.append("_page", String(input.page));
10
+ if (input.perPage)
11
+ params.append("_itemsOnPage", String(input.perPage));
12
+ if (input.name)
13
+ params.append("name", input.name);
14
+ if (input.identifier)
15
+ params.append("identifier", input.identifier);
16
+ const queryString = params.toString();
17
+ const url = `/${storeCode}/channel${queryString ? `?${queryString}` : ""}`;
18
+ try {
19
+ const response = await apiGet(url);
20
+ return response;
21
+ }
22
+ catch (error) {
23
+ throw formatApiError(error, "ol_channel_list");
24
+ }
25
+ }
26
+ export async function channelCreate(input) {
27
+ const storeCode = getStoreCode(input.storeCode);
28
+ const payload = {
29
+ name: input.name,
30
+ identifier: input.identifier,
31
+ };
32
+ if (input.description)
33
+ payload.description = input.description;
34
+ try {
35
+ const response = await apiPost(`/${storeCode}/channel`, { channel: payload });
36
+ return response;
37
+ }
38
+ catch (error) {
39
+ if (axios.isAxiosError(error) && error.response?.status === 400) {
40
+ const allMessages = [
41
+ error.response?.data?.message || "",
42
+ ...(error.response?.data?.errors || []).map((e) => e.message),
43
+ ].join(" ").toLowerCase();
44
+ if (allMessages.includes("identifier") && (allMessages.includes("unique") || allMessages.includes("exists") || allMessages.includes("already"))) {
45
+ throw new OpenLoyaltyError({
46
+ code: "DUPLICATE_IDENTIFIER",
47
+ message: `Channel with identifier '${input.identifier}' already exists`,
48
+ hint: `Use ol_channel_list() to find the existing channel, or choose a different identifier.`,
49
+ relatedTool: "ol_channel_create",
50
+ });
51
+ }
52
+ }
53
+ throw formatApiError(error, "ol_channel_create");
54
+ }
55
+ }
56
+ export async function channelGet(input) {
57
+ const storeCode = getStoreCode(input.storeCode);
58
+ try {
59
+ const response = await apiGet(`/${storeCode}/channel/${input.channelId}`);
60
+ return response;
61
+ }
62
+ catch (error) {
63
+ if (axios.isAxiosError(error) && error.response?.status === 404) {
64
+ throw new OpenLoyaltyError({
65
+ code: "NOT_FOUND",
66
+ message: `Channel '${input.channelId}' not found`,
67
+ hint: "Use ol_channel_list() to find existing channels and their IDs.",
68
+ relatedTool: "ol_channel_get",
69
+ });
70
+ }
71
+ throw formatApiError(error, "ol_channel_get");
72
+ }
73
+ }
74
+ export async function channelUpdate(input) {
75
+ const storeCode = getStoreCode(input.storeCode);
76
+ const payload = {
77
+ name: input.name,
78
+ identifier: input.identifier,
79
+ };
80
+ if (input.description !== undefined)
81
+ payload.description = input.description;
82
+ try {
83
+ const response = await apiPut(`/${storeCode}/channel/${input.channelId}`, { channel: payload });
84
+ return response;
85
+ }
86
+ catch (error) {
87
+ if (axios.isAxiosError(error)) {
88
+ if (error.response?.status === 404) {
89
+ throw new OpenLoyaltyError({
90
+ code: "NOT_FOUND",
91
+ message: `Channel '${input.channelId}' not found`,
92
+ hint: "Use ol_channel_list() to find existing channels and their IDs.",
93
+ relatedTool: "ol_channel_update",
94
+ });
95
+ }
96
+ if (error.response?.status === 400) {
97
+ const allMessages = [
98
+ error.response?.data?.message || "",
99
+ ...(error.response?.data?.errors || []).map((e) => e.message),
100
+ ].join(" ").toLowerCase();
101
+ if (allMessages.includes("identifier") && (allMessages.includes("unique") || allMessages.includes("exists") || allMessages.includes("already"))) {
102
+ throw new OpenLoyaltyError({
103
+ code: "DUPLICATE_IDENTIFIER",
104
+ message: `Channel with identifier '${input.identifier}' already exists`,
105
+ hint: `Use ol_channel_list() to find channels with that identifier, or choose a different identifier.`,
106
+ relatedTool: "ol_channel_update",
107
+ });
108
+ }
109
+ }
110
+ }
111
+ throw formatApiError(error, "ol_channel_update");
112
+ }
113
+ }
114
+ export async function channelDelete(input) {
115
+ const storeCode = getStoreCode(input.storeCode);
116
+ try {
117
+ await apiDelete(`/${storeCode}/channel/${input.channelId}`);
118
+ }
119
+ catch (error) {
120
+ if (axios.isAxiosError(error) && error.response?.status === 404) {
121
+ throw new OpenLoyaltyError({
122
+ code: "NOT_FOUND",
123
+ message: `Channel '${input.channelId}' not found`,
124
+ hint: "Use ol_channel_list() to find existing channels and their IDs.",
125
+ relatedTool: "ol_channel_delete",
126
+ });
127
+ }
128
+ throw formatApiError(error, "ol_channel_delete");
129
+ }
130
+ }