Skip to main content

MCP Tools Reference

All 30 tools available in the Loyalteez MCP server.

Program Design Tools​

loyalteez_design_program​

Design a complete loyalty program based on community type.

Parameters:

  • communityType (required): Type of community (gaming, developer, ecommerce, creator, etc.)
  • goals (optional): Specific goals for the program
  • budget (optional): Monthly LTZ budget

Returns: Complete program design with events, rewards, and implementation code.

loyalteez_create_events_batch​

Create multiple events at once.

Parameters:

  • events (required): Array of event configurations
  • brandId (required): Your brand ID

Returns: Created events with IDs and configurations.

Event Tools​

loyalteez_track_event​

Track an event and distribute rewards.

Parameters:

  • eventType (required): Event type ID
  • userEmail (required): User identifier
  • metadata (optional): Additional event data

Returns: Reward amount, transaction hash, new balance.

loyalteez_create_event​

Create a new event type.

Parameters:

  • name (required): Event name
  • rewardAmount (required): LTZ reward
  • cooldownHours (optional): Hours between claims
  • maxClaims (optional): Max claims per user

loyalteez_update_event​

Update an existing event.

Parameters:

  • eventId (required): Event to update
  • rewardAmount (optional): New reward
  • enabled (optional): Enable/disable

loyalteez_list_events​

List all events for a brand.

Returns: Array of event configurations.

User Tools​

loyalteez_get_balance​

Get a user's LTZ balance.

Parameters:

  • userEmail (required): User identifier

Returns: Balance in LTZ, wallet address.

loyalteez_get_user_stats​

Get comprehensive user statistics.

Parameters:

  • userEmail (required): User identifier

Returns: Balance, activity, streaks, achievements.

loyalteez_reward_user​

Send LTZ to a user.

Parameters:

  • userEmail (required): User identifier
  • amount (required): LTZ amount
  • reason (optional): Reason for reward

Returns: Transaction hash, new balance.

Streak Tools​

loyalteez_get_streak​

Get a user's streak information.

Parameters:

  • userEmail (required): User identifier

Returns: Current streak, longest streak, multiplier.

loyalteez_record_activity​

Record user activity for streak tracking.

Parameters:

  • userEmail (required): User identifier
  • activityType (required): Type of activity

loyalteez_get_streak_leaderboard​

Get streak leaderboard.

Parameters:

  • limit (optional): Number of results (default: 10)

Returns: Ranked list of users by streak.

Leaderboard Tools​

loyalteez_get_leaderboard​

Get leaderboard by metric.

Parameters:

  • metric (required): ltz_earned, activity_score, claims_count, streak_current
  • period (optional): daily, weekly, monthly, all_time
  • limit (optional): Number of results

Returns: Ranked user list with scores.

Drop Tools​

loyalteez_create_drop​

Create a new drop (reaction or button).

Parameters:

  • eventId (required): Event to trigger
  • type (required): button or reaction
  • maxClaims (optional): Total claim limit
  • expiresIn (optional): Expiration time

Returns: Drop ID, claim URL/code.

loyalteez_get_drop_stats​

Get statistics for a drop.

Parameters:

  • dropId (required): Drop ID

Returns: Claims count, remaining, claimers.

loyalteez_cancel_drop​

Cancel an active drop.

Parameters:

  • dropId (required): Drop to cancel

Perk Tools​

loyalteez_create_perk​

Create a new redeemable perk.

Parameters:

  • name (required): Perk name
  • price (required): Price in LTZ
  • description (optional): Perk description
  • maxSupply (optional): Total supply
  • category (optional): Perk category

Returns: Perk ID, configuration.

loyalteez_list_perks​

List all perks for a brand.

Returns: Array of perks with prices and availability.

loyalteez_update_perk​

Update an existing perk.

Parameters:

  • perkId (required): Perk to update
  • price (optional): New price
  • enabled (optional): Enable/disable

loyalteez_get_perk_claims​

Get claim history for a perk.

Parameters:

  • perkId (required): Perk ID

Returns: List of claims with timestamps.

Achievement Tools​

loyalteez_create_achievement​

Create a new achievement.

Parameters:

  • name (required): Achievement name
  • type (required): message_count, streak_days, etc.
  • threshold (required): Value to trigger
  • reward (required): LTZ reward

loyalteez_list_achievements​

List all achievements for a brand.

Returns: Array of achievements with configurations.

loyalteez_get_user_achievements​

Get a user's achievement progress.

Parameters:

  • userEmail (required): User identifier

Returns: Unlocked achievements, progress.

Analytics Tools​

loyalteez_get_analytics​

Get program analytics.

Parameters:

  • period (optional): day, week, month
  • metrics (optional): Specific metrics to include

Returns: LTZ distributed, active users, event breakdown.

loyalteez_get_event_stats​

Get statistics for a specific event.

Parameters:

  • eventId (required): Event ID
  • period (optional): Time period

Returns: Claims, unique users, LTZ distributed.

Documentation Tools​

loyalteez_get_docs​

Get documentation content.

Parameters:

  • topic (required): Topic to retrieve (discord, telegram, api, etc.)

Returns: Relevant documentation content.

loyalteez_search_docs​

Search documentation.

Parameters:

  • query (required): Search query

Returns: Matching documentation sections.

Utility Tools​

loyalteez_generate_code​

Generate integration code.

Parameters:

  • language (required): javascript, python, go, curl
  • task (required): What the code should do

Returns: Ready-to-use code snippet.

loyalteez_validate_config​

Validate a program configuration.

Parameters:

  • config (required): Configuration to validate

Returns: Validation results, suggestions.

Last updated on