@open-loyalty/mcp-server 1.14.1 → 1.16.1

package/dist/instructions.d.ts

@@ -2,4 +2,4 @@
  * MCP Server Instructions - provides context and guidance for AI agents
  * using the Open Loyalty MCP server.
  */
-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 LOCK: When OPENLOYALTY_DEFAULT_STORE_CODE is configured, the store code is HARD-LOCKED. All API calls will use the configured default \u2014 any storeCode parameter you pass is silently ignored. Do NOT attempt to use a different store code. To switch stores, the user must change the OPENLOYALTY_DEFAULT_STORE_CODE environment variable and restart the server.\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\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- When OPENLOYALTY_DEFAULT_STORE_CODE is configured, the store code is HARD-LOCKED \u2014 all tools use the configured default regardless of any storeCode parameter you pass\n- Do NOT attempt to switch stores. To use a different store, the user must change the environment variable and restart the server\n- If no default is configured, ask the user which store to use at session start\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";
+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 LOCK: When OPENLOYALTY_DEFAULT_STORE_CODE is configured, the store code is HARD-LOCKED. All API calls will use the configured default \u2014 any storeCode parameter you pass is silently ignored. Do NOT attempt to use a different store code. To switch stores, the user must change the OPENLOYALTY_DEFAULT_STORE_CODE environment variable and restart the server.\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\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 \"calendarHours\", \"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- When OPENLOYALTY_DEFAULT_STORE_CODE is configured, the store code is HARD-LOCKED \u2014 all tools use the configured default regardless of any storeCode parameter you pass\n- Do NOT attempt to switch stores. To use a different store, the user must change the environment variable and restart the server\n- If no default is configured, ask the user which store to use at session start\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";

package/dist/instructions.js

@@ -311,7 +311,7 @@ Campaign limits structure:
     }
   }
 }
-Note: Use "calendarDays" (not "days"), "calendarWeeks", "calendarMonths", "calendarYears".
+Note: Use "calendarHours", "calendarDays" (not "days"), "calendarWeeks", "calendarMonths", "calendarYears".
 Omit interval entirely for lifetime/forever limit.
 
 ### Pattern 5: Achievement-Triggered Bonus

package/dist/server.js

@@ -41,7 +41,7 @@ function normalizeToolInput(toolName, args) {
 export function createServer() {
     const server = new McpServer({
         name: "openloyalty",
-        version: "1.14.1",
+        version: "1.15.0",
     });
     const tools = getAllTools();
     for (const tool of tools) {

package/dist/tools/analytics/handlers.js

@@ -216,7 +216,7 @@ export async function analyticsDashboard(input) {
                 throw new OpenLoyaltyError({
                     code: "INVALID_DATE_RANGE",
                     message: "Invalid date range or format for dashboard analytics",
-                    hint: "Use YYYY-MM-DD format for intervalStartDate and intervalEndDate (e.g., '2026-01-01'). Ensure start date is before end date. Valid aggregationType values: 'day', 'week', 'month'.",
+                    hint: "Use YYYY-MM-DD format for intervalStartDate and intervalEndDate (e.g., '2026-01-01'). Ensure start date is before end date. Valid aggregationType values: 'day', 'week', 'month', 'year'.",
                     relatedTool: "ol_analytics_dashboard",
                 });
             }
@@ -224,7 +224,7 @@ export async function analyticsDashboard(input) {
                 throw new OpenLoyaltyError({
                     code: "INVALID_DATA_TYPE",
                     message: "Invalid dataType value for dashboard analytics",
-                    hint: "Valid dataType values: registeredMembers, activeMembers, revenue, avgSpending, transactions, avgTransactionValue, avgNumberOfTransactions.",
+                    hint: "Valid dataType values: registeredMembers, activeMembers, revenue, avgSpending, transactions, avgTransactionValue, avgNumberOfTransactions, returnTransactions, totalReturns, avgReturnValue, avgNumberOfReturnTransactions.",
                     relatedTool: "ol_analytics_dashboard",
                 });
             }

package/dist/tools/analytics/index.d.ts

@@ -73,8 +73,8 @@ export declare const analyticsToolDefinitions: readonly [{
     readonly idempotent: true;
     readonly inputSchema: {
         storeCode: import("zod").ZodOptional<import("zod").ZodString>;
-        dataType: import("zod").ZodEnum<["registeredMembers", "activeMembers", "revenue", "avgSpending", "transactions", "avgTransactionValue", "avgNumberOfTransactions"]>;
-        aggregationType: import("zod").ZodOptional<import("zod").ZodEnum<["day", "week", "month"]>>;
+        dataType: import("zod").ZodEnum<["registeredMembers", "activeMembers", "revenue", "avgSpending", "transactions", "avgTransactionValue", "avgNumberOfTransactions", "returnTransactions", "totalReturns", "avgReturnValue", "avgNumberOfReturnTransactions"]>;
+        aggregationType: import("zod").ZodOptional<import("zod").ZodEnum<["day", "week", "month", "year"]>>;
         intervalStartDate: import("zod").ZodOptional<import("zod").ZodString>;
         intervalEndDate: import("zod").ZodOptional<import("zod").ZodString>;
     };
@@ -88,8 +88,8 @@ export declare const analyticsToolDefinitions: readonly [{
     readonly inputSchema: {
         storeCode: import("zod").ZodOptional<import("zod").ZodString>;
         walletTypeCode: import("zod").ZodString;
-        dataType: import("zod").ZodOptional<import("zod").ZodEnum<["unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive"]>>;
-        aggregationType: import("zod").ZodOptional<import("zod").ZodEnum<["day", "week", "month"]>>;
+        dataType: import("zod").ZodOptional<import("zod").ZodEnum<["unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive", "redemptionRate", "breakageRate"]>>;
+        aggregationType: import("zod").ZodOptional<import("zod").ZodEnum<["day", "week", "month", "year"]>>;
         intervalStartDate: import("zod").ZodOptional<import("zod").ZodString>;
         intervalEndDate: import("zod").ZodOptional<import("zod").ZodString>;
     };

package/dist/tools/analytics/schemas.d.ts

@@ -23,16 +23,16 @@ export declare const AnalyticsCampaignsInputSchema: {
 };
 export declare const AnalyticsDashboardInputSchema: {
     storeCode: z.ZodOptional<z.ZodString>;
-    dataType: z.ZodEnum<["registeredMembers", "activeMembers", "revenue", "avgSpending", "transactions", "avgTransactionValue", "avgNumberOfTransactions"]>;
-    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+    dataType: z.ZodEnum<["registeredMembers", "activeMembers", "revenue", "avgSpending", "transactions", "avgTransactionValue", "avgNumberOfTransactions", "returnTransactions", "totalReturns", "avgReturnValue", "avgNumberOfReturnTransactions"]>;
+    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month", "year"]>>;
     intervalStartDate: z.ZodOptional<z.ZodString>;
     intervalEndDate: z.ZodOptional<z.ZodString>;
 };
 export declare const AnalyticsUnitsInputSchema: {
     storeCode: z.ZodOptional<z.ZodString>;
     walletTypeCode: z.ZodString;
-    dataType: z.ZodOptional<z.ZodEnum<["unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive"]>>;
-    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+    dataType: z.ZodOptional<z.ZodEnum<["unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive", "redemptionRate", "breakageRate"]>>;
+    aggregationType: z.ZodOptional<z.ZodEnum<["day", "week", "month", "year"]>>;
     intervalStartDate: z.ZodOptional<z.ZodString>;
     intervalEndDate: z.ZodOptional<z.ZodString>;
 };

package/dist/tools/analytics/schemas.js

@@ -25,9 +25,10 @@ export const AnalyticsDashboardInputSchema = {
     storeCode: z.string().optional().describe("Store code. LOCKED to the configured default when OPENLOYALTY_DEFAULT_STORE_CODE is set — any value passed here is silently ignored. Only used as fallback when no default is configured."),
     dataType: z.enum([
         "registeredMembers", "activeMembers", "revenue", "avgSpending",
-        "transactions", "avgTransactionValue", "avgNumberOfTransactions"
-    ]).describe("REQUIRED: Type of data to retrieve. Options: registeredMembers, activeMembers, revenue, avgSpending, transactions, avgTransactionValue, avgNumberOfTransactions."),
-    aggregationType: z.enum(["day", "week", "month"]).optional().describe("Aggregation granularity."),
+        "transactions", "avgTransactionValue", "avgNumberOfTransactions",
+        "returnTransactions", "totalReturns", "avgReturnValue", "avgNumberOfReturnTransactions"
+    ]).describe("REQUIRED: Type of data to retrieve. Options: registeredMembers, activeMembers, revenue, avgSpending, transactions, avgTransactionValue, avgNumberOfTransactions, returnTransactions, totalReturns, avgReturnValue, avgNumberOfReturnTransactions."),
+    aggregationType: z.enum(["day", "week", "month", "year"]).optional().describe("Aggregation granularity."),
     intervalStartDate: z.string().optional().describe("Start date (YYYY-MM-DD format)."),
     intervalEndDate: z.string().optional().describe("End date (YYYY-MM-DD format)."),
 };
@@ -35,9 +36,10 @@ export const AnalyticsUnitsInputSchema = {
     storeCode: z.string().optional().describe("Store code. LOCKED to the configured default when OPENLOYALTY_DEFAULT_STORE_CODE is set — any value passed here is silently ignored. Only used as fallback when no default is configured."),
     walletTypeCode: z.string().describe("Wallet type code (e.g., 'default' or 'points')."),
     dataType: z.enum([
-        "unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive"
+        "unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive",
+        "redemptionRate", "breakageRate"
     ]).optional().describe("Type of data to retrieve."),
-    aggregationType: z.enum(["day", "week", "month"]).optional().describe("Aggregation granularity."),
+    aggregationType: z.enum(["day", "week", "month", "year"]).optional().describe("Aggregation granularity."),
     intervalStartDate: z.string().optional().describe("Start date (YYYY-MM-DD format)."),
     intervalEndDate: z.string().optional().describe("End date (YYYY-MM-DD format)."),
 };

package/dist/tools/apps/dashboard/handlers.d.ts

@@ -1,13 +1,28 @@
+export declare const GENERAL_DASHBOARD_METRICS: readonly ["registeredMembers", "activeMembers", "revenue", "avgSpending", "transactions", "avgTransactionValue", "avgNumberOfTransactions"];
+export declare const UNITS_DASHBOARD_METRICS: readonly ["unitsIssued", "unitsSpent", "unitsExpired", "unitsPending", "unitsActive", "redemptionRate", "breakageRate"];
+type GeneralMetric = (typeof GENERAL_DASHBOARD_METRICS)[number];
+type UnitsMetric = (typeof UNITS_DASHBOARD_METRICS)[number];
+export interface DashboardSeries {
+    dataType: string;
+    aggregationType?: string;
+    intervalStartDate?: string;
+    intervalEndDate?: string;
+    data: Record<string, unknown>;
+}
+export interface DashboardSection<THeader, TMetric extends string> {
+    header: THeader | null;
+    series: Partial<Record<TMetric, DashboardSeries>>;
+}
 export interface DashboardData {
-    overview: unknown;
-    tiers: unknown;
-    members: unknown;
-    points: unknown;
-    campaigns: unknown;
-    units: unknown;
+    general: DashboardSection<Record<string, number>, GeneralMetric>;
+    units: DashboardSection<Record<string, number>, UnitsMetric> & {
+        walletTypeCode: string;
+    };
+    errors: Record<string, string>;
 }
 export declare function aggregateDashboard(input: {
     storeCode?: string;
     intervalStartDate?: string;
     intervalEndDate?: string;
 }): Promise<DashboardData>;
+export {};

package/dist/tools/apps/dashboard/handlers.js

@@ -1,23 +1,80 @@
-import { analyticsDashboard, analyticsTiers, analyticsMembers, analyticsPoints, analyticsCampaigns, analyticsUnits, } from "../../analytics/handlers.js";
+import { analyticsDashboard, analyticsUnits, } from "../../analytics/handlers.js";
+export const GENERAL_DASHBOARD_METRICS = [
+    "registeredMembers",
+    "activeMembers",
+    "revenue",
+    "avgSpending",
+    "transactions",
+    "avgTransactionValue",
+    "avgNumberOfTransactions",
+];
+export const UNITS_DASHBOARD_METRICS = [
+    "unitsIssued",
+    "unitsSpent",
+    "unitsExpired",
+    "unitsPending",
+    "unitsActive",
+    "redemptionRate",
+    "breakageRate",
+];
 export async function aggregateDashboard(input) {
     const { storeCode, intervalStartDate, intervalEndDate } = input;
-    // Fetch all analytics in parallel — each may fail independently
-    const [overview, tiers, members, points, campaigns, units] = await Promise.all([
-        analyticsDashboard({
+    const walletTypeCode = "default";
+    const [generalResults, unitsResults] = await Promise.all([
+        Promise.all(GENERAL_DASHBOARD_METRICS.map((dataType) => captureMetric(dataType, analyticsDashboard({
             storeCode,
+            dataType,
             intervalStartDate,
             intervalEndDate,
-        }).catch(() => null),
-        analyticsTiers({ storeCode }).catch(() => null),
-        analyticsMembers({ storeCode }).catch(() => null),
-        analyticsPoints({ storeCode }).catch(() => null),
-        analyticsCampaigns({ storeCode, perPage: 10 }).catch(() => null),
-        analyticsUnits({
+        })))),
+        Promise.all(UNITS_DASHBOARD_METRICS.map((dataType) => captureMetric(dataType, analyticsUnits({
             storeCode,
-            walletTypeCode: "default",
+            walletTypeCode,
+            dataType,
             intervalStartDate,
             intervalEndDate,
-        }).catch(() => null),
+        })))),
     ]);
-    return { overview, tiers, members, points, campaigns, units };
+    const errors = {};
+    return {
+        general: normalizeSection(generalResults, errors, "general"),
+        units: {
+            ...normalizeSection(unitsResults, errors, "units"),
+            walletTypeCode,
+        },
+        errors,
+    };
+}
+async function captureMetric(metric, promise) {
+    try {
+        return { metric, response: await promise };
+    }
+    catch (error) {
+        return { metric, error: getErrorMessage(error) };
+    }
+}
+function normalizeSection(results, errors, errorPrefix) {
+    let header = null;
+    const series = {};
+    for (const result of results) {
+        if ("error" in result) {
+            errors[`${errorPrefix}.${result.metric}`] = result.error;
+            continue;
+        }
+        header ??= result.response.header ?? null;
+        series[result.metric] = {
+            dataType: result.response.dataType ?? result.metric,
+            aggregationType: result.response.aggregationType,
+            intervalStartDate: result.response.intervalStartDate,
+            intervalEndDate: result.response.intervalEndDate,
+            data: result.response.data ?? {},
+        };
+    }
+    return { header, series };
+}
+function getErrorMessage(error) {
+    if (error instanceof Error) {
+        return error.message;
+    }
+    return String(error);
 }

package/dist/tools/campaign/handlers.js

@@ -1,6 +1,7 @@
 import { apiGet, apiPost, apiPut, apiPatch, apiDelete } from "../../client/http.js";
 import { formatApiError, OpenLoyaltyError } from "../../utils/errors.js";
 import { getStoreCode } from "../../config.js";
+import { normalizeCampaignLimits, normalizeCampaignRules, normalizeCampaignVisibility, VALID_LIMIT_INTERVAL_TYPES, } from "./normalizers.js";
 // Core CRUD handlers
 export async function campaignList(input) {
     const storeCode = getStoreCode(input.storeCode);
@@ -81,14 +82,16 @@ export async function campaignCreate(input) {
         trigger: input.trigger,
         translations: input.translations,
         activity: input.activity,
-        rules: input.rules,
+        rules: normalizeCampaignRules(input.rules),
     };
-    if (input.visibility)
-        campaignPayload.visibility = input.visibility;
+    const visibility = normalizeCampaignVisibility(input.visibility);
+    const limits = normalizeCampaignLimits(input);
+    if (visibility)
+        campaignPayload.visibility = visibility;
     if (input.audience)
         campaignPayload.audience = input.audience;
-    if (input.limits)
-        campaignPayload.limits = input.limits;
+    if (limits)
+        campaignPayload.limits = limits;
     if (input.active !== undefined)
         campaignPayload.active = input.active;
     if (input.displayOrder !== undefined)
@@ -119,6 +122,22 @@ export async function campaignCreate(input) {
                 relatedTool: "ol_campaign_create",
             });
         }
+        if (allMessages.includes("visibility") && allMessages.includes("target") && allMessages.includes("choice")) {
+            throw new OpenLoyaltyError({
+                code: "INVALID_VISIBILITY_TARGET",
+                message: "Invalid campaign visibility target",
+                hint: "Valid visibility targets are 'tier', 'segment', and 'none' (invisible to everyone). Omit visibility for all-member visibility. Do not send 'all'; ol_campaign_create normalizes it by omitting visibility before the API call.",
+                relatedTool: "ol_campaign_create",
+            });
+        }
+        if (allMessages.includes("interval") && allMessages.includes("choice")) {
+            throw new OpenLoyaltyError({
+                code: "INVALID_LIMIT_INTERVAL",
+                message: "Invalid campaign limit interval type",
+                hint: `Valid campaign limit interval types: ${VALID_LIMIT_INTERVAL_TYPES.map((type) => `'${type}'`).join(", ")}. interval.value is required when interval is present. Omit interval entirely for a lifetime limit.`,
+                relatedTool: "ol_campaign_create",
+            });
+        }
         if (allMessages.includes("operator") || (allMessages.includes("condition") && allMessages.includes("choice"))) {
             throw new OpenLoyaltyError({
                 code: "INVALID_CONDITION",