Skip to main content

MCP Resources Reference

Resources provide read-only access to Loyalteez configuration and documentation.

Contract Resources​

loyalteez://contracts​

Smart contract addresses for the current network.

Returns:

{
  "network": "mainnet",
  "chainId": 1868,
  "contracts": {
    "LoyalteezToken": "0x5242b6DB88A72752ac5a54cFe6A7DB8244d743c9",
    "PerkNFT": "0x6ae30d6Dcf3e75456B6582b057f1Bf98A90F2CA0",
    "PointsSale": "0x5269B83F6A4E31bEdFDf5329DC052FBb661e3c72"
  }
}

loyalteez://network​

Network configuration for the current environment.

Returns:

{
  "name": "Soneium Mainnet",
  "chainId": 1868,
  "rpcUrl": "https://rpc.soneium.org",
  "blockExplorer": "https://soneium.blockscout.com",
  "nativeCurrency": {
    "name": "ETH",
    "symbol": "ETH",
    "decimals": 18
  }
}

Event Resources​

loyalteez://event-types​

Standard event types and their recommended configurations.

Returns:

{
  "standard_events": [
    {
      "type": "daily_checkin",
      "description": "Daily check-in reward",
      "recommended_reward": 10,
      "recommended_cooldown": 24
    },
    {
      "type": "gm_checkin",
      "description": "Good morning message reward",
      "recommended_reward": 25,
      "recommended_cooldown": 24
    },
    // ... more event types
  ]
}

loyalteez://event-templates​

Industry-specific event templates.

Returns:

{
  "templates": {
    "gaming": {
      "events": ["quest_completed", "achievement_unlocked", "pvp_win"],
      "description": "Events for gaming communities"
    },
    "developer": {
      "events": ["code_review", "bug_report", "helpful_answer"],
      "description": "Events for developer communities"
    },
    // ... more templates
  }
}

API Resources​

loyalteez://api-endpoints​

API endpoint documentation.

Returns:

{
  "endpoints": {
    "event_handler": {
      "url": "https://api.loyalteez.app/loyalteez-api/manual-event",
      "method": "POST",
      "description": "Track events and distribute rewards",
      "authentication": "HMAC Signature"
    },
    "gas_relayer": {
      "url": "https://relayer.loyalteez.app/relay",
      "method": "POST",
      "description": "Execute gasless transactions"
    }
  }
}

loyalteez://error-codes​

Error codes and their meanings.

Returns:

{
  "errors": {
    "COOLDOWN_ACTIVE": {
      "code": 429,
      "message": "User is on cooldown for this event",
      "resolution": "Wait for cooldown to expire"
    },
    "INSUFFICIENT_BALANCE": {
      "code": 400,
      "message": "Brand has insufficient LTZ balance",
      "resolution": "Add funds in Partner Portal"
    }
    // ... more error codes
  }
}

Documentation Resources​

loyalteez://docs/discord​

Discord integration documentation.

Returns: Markdown content of Discord integration guide.

loyalteez://docs/telegram​

Telegram integration documentation.

Returns: Markdown content of Telegram integration guide.

loyalteez://docs/api​

API reference documentation.

Returns: Markdown content of API reference.

loyalteez://docs/sdk​

SDK documentation and usage.

Returns: Markdown content of SDK documentation.

Best Practices Resource​

loyalteez://best-practices​

Program design best practices.

Returns:

{
  "program_design": {
    "reward_balance": "Keep daily rewards between 10-50 LTZ",
    "cooldowns": "Use 24h cooldown for daily events",
    "progression": "Create clear progression paths"
  },
  "security": {
    "key_rotation": "Rotate security keys quarterly",
    "signature_validation": "Always validate HMAC signatures"
  },
  "engagement": {
    "daily_hooks": "Include daily check-in and GM/GN events",
    "milestones": "Create achievable short-term goals"
  }
}

Using Resources​

Resources are accessed automatically by the AI when relevant. You can also request them explicitly:

"Show me the Loyalteez contract addresses"

"What are the recommended event types for a gaming community?"

"What does error code COOLDOWN_ACTIVE mean?"

The AI will query the appropriate resource and present the information.

Last updated on