Loyal Spark Loyalty Protocol

by aspekt19

420 downloads
Not rated
GitHub

About

Onchain Loyalty-as-a-Service on Base L2. AI agents can create loyalty programs, mint ERC-20 tokens, manage rewards, trade on P2P marketplace, and get MPC wallets — all via MCP Server.

Details

Author
aspekt19
Downloads
420
Categories
Other, AI

- Onchain loyalty protocol deployed on Base L2
- Create and manage loyalty programs
- Mint loyalty tokens with onchain calldata
- Create and list rewards per program
- Query customer token balances and tier levels
- Retrieve program analytics and metrics
- List and browse P2P marketplace offers

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Loyal Spark Loyalty Protocol
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Register at loyalspark.online/merchant in the AI Agents tab, obtain an API key with the lsk_ prefix, and include it in the x-api-key header. Then invoke the available tools such as get_platform_info, list_loyalty_programs, create_reward, mint_loyalty_tokens, and list_marketplace_offers.

get_platform_info

Get info about Loyal Spark protocol on Base L2

get_my_profile

Get authenticated agent's profile

generate_program_defaults

Workflow planner: field catalog, required parameters, next_actions, and non-binding examples. External agents must choose their own name, symbol, and economics.

get_program_workflow_status

Explain the next merchant action: current_step, required fields, and ordered next_actions (you provide all parameter values)

list_loyalty_programs

List loyalty programs owned by the agent's merchant

create_loyalty_program

Get factory calldata to deploy a new loyalty token on Base. Defaults to B20 (Base native ERC-20 superset, single tx, active immediately). Pass token_standard='erc20' for the legacy factory. For B20, MINT_ROLE is granted atomically to the merchant admin AND to the agent's CDP wallet (or explicit extra_minters) so autonomous agents can mint with no follow-up transaction.

register_loyalty_program

Register a deployed token as a loyalty program in the database. B20 tokens are registered as active; legacy ERC-20 as inactive (activate next).

activate_loyalty_program

For legacy ERC-20 programs: returns unpauseUtility + enableMinting calldata. For B20 programs: no-op (already active).

update_program_status

Update program status in database after onchain activation/pause

update_program_config

Update default cashback_rate and/or points_per_dollar for a program (same as merchant dashboard sliders)

list_rewards

List rewards for a loyalty program by token_address. Includes redemption metrics (total vouchers issued, redeemed, and last-30-day counts) for each reward.

create_reward

Create a new reward redeemable with loyalty tokens

mint_loyalty_tokens

Record mint intent and get a fee-first `calls[]` bundle: protocol fee mint FIRST, then the recipient mint. The protocol fee is charged in the merchant's own loyalty tokens (not USDC). Submit both calls in order (atomically via EIP-5792 send_calls if your wallet supports it), then call confirm_mint_fee (or POST /agent-api/mint/confirm) with the fee tx hash. Unconfirmed fee obligations block future mints.

transfer_loyalty_tokens

Get calldata to transfer loyalty tokens between wallets

earn_points

Calculate and mint loyalty tokens based on purchase amount and program's cashback rate. Returns a fee-first `calls[]` bundle (protocol fee mint first, then the customer mint) — submit in order, atomically via EIP-5792 if supported, then call confirm_mint_fee (or POST /agent-api/mint/confirm). Unconfirmed fee obligations block future mints.

confirm_mint_fee

Confirm that the protocol fee transaction for a previous mint/earn was broadcast on Base. Verifies the fee mint on-chain and clears the obligation. Unconfirmed fee obligations block future mints.

get_token_balance

Get loyalty token balance and tier info for a customer

get_program_analytics

Get analytics for your loyalty programs

list_marketplace_offers

List active token trading offers on the marketplace

redeem_reward

Redeem a reward by providing a verified token transfer transaction hash. Creates a voucher for the customer.

use_voucher

Mark a voucher as used (redeemed by customer at merchant). Merchant-only operation.

check_voucher_status

Check voucher status by code or ID. Public endpoint — no API key or authentication required.

get_platform_stats

Get global platform statistics across all merchants. Admin-only: requires agent owned by an admin wallet.

cancel_stale_offers

Cancel marketplace offers that have been active for more than N days with no completions. Admin-only action tool.

create_personalized_offer

Create a personalized offer for a specific customer. Use when analytics reveal engagement patterns (e.g., inactive customers, high-value segments).

update_reward_status

Activate or deactivate a reward in the catalog. Use to manage reward availability based on analytics.

send_report

Send a report to the developer/owner. Use this to submit SEO audits, growth ideas, data reports, anomalies, recommendations, or weekly summaries. The report will appear in the merchant's Agent Reports dashboard.

list_my_reports

List your previously submitted reports. Allows reviewing past reports, checking status (new/reviewed/done), and identifying what still needs attention.

update_report_status

Update report status to 'reviewed' or 'done'. Use 'done' when the action items have been completed. Use 'reviewed' to acknowledge a report.

delete_report

Delete a report that is no longer relevant. Use to clean up outdated or irrelevant reports.

export_customers

Export customer data for a specific loyalty program. Returns wallet addresses, voucher stats, balances, and tier info. Use for analytics, segmentation, and personalized offers.

create_gift_certificate

Create a gift / welcome certificate (UDS-style) with a unique 6-character redemption code (LOYAL-XXXXXX). Customer redeems via QR or by entering the code; merchant then mints tokens on-chain. Use for welcome bonuses, promo campaigns, partnership gifts.

list_gift_certificates

List gift certificates issued by the agent's merchant (with status and redemption info).

revoke_gift_certificate

Revoke an active gift certificate (status active → revoked). Only the issuing merchant can revoke. Already-redeemed/minted certificates cannot be revoked.

mark_gift_certificate_minted

After the merchant submits the on-chain mint transaction for a claimed gift certificate, call this to mark it as minted (status pending_mint → redeemed) and store the mint tx hash.

bazaar_discover_resources

Discover third-party x402-paid resources published in Coinbase CDP's Bazaar (docs, data feeds, AI inference, etc). Read-only. Filter by free-text q and/or network (e.g. 'base').

bazaar_discover_mcp_servers

Discover third-party MCP servers published in Coinbase CDP's Bazaar. Read-only. Filter by free-text q and/or network.

bazaar_probe_x402

GET a candidate x402 URL and, if it responds HTTP 402, return the parsed payment requirements (accepts[]) so the caller can decide whether to pay. HTTPS only. No signing performed.

bazaar_pay_and_call

Pay and call any x402-paid HTTPS endpoint using the merchant agent's CDP MPC wallet (EIP-3009 exact scheme on Base USDC). Probes the URL for HTTP 402, picks a compatible requirement, signs TransferWithAuthorization via CDP, retries with X-PAYMENT header, and returns the paid response. Requires scope 'mint' and a pre-created CDP wallet. Safety cap: max_usdc (default 0.25, hard limit 10).

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "loyal spark loyalty protocol": {
            "loyal-spark": {
                "url": "https://bzxmejzssxjazswgwqqs.supabase.co/functions/v1/loyalty-mcp",
                "transport": "streamable-http",
                "headers": {
                    "x-api-key": "<YOUR_API_KEY>"
                }
            }
        }
    }
}

McpServers

{
    "loyal-spark": {
        "url": "https://bzxmejzssxjazswgwqqs.supabase.co/functions/v1/loyalty-mcp",
        "transport": "streamable-http",
        "headers": {
            "x-api-key": "<YOUR_API_KEY>"
        }
    }
}

Loyal Spark — Loyalty-as-a-Service for AI Agents

Onchain loyalty protocol on Base L2. Create programs, mint tokens, manage rewards, trade on marketplace.

Available Tools

| Tool | Description | |------|-------------| | get_platform_info | Protocol info (chain, features) | | get_my_profile | Agent profile & permissions | | list_loyalty_programs | List merchant's programs | | list_rewards | Rewards for a program | | create_reward | Create new reward (manage_rewards scope) | | mint_loyalty_tokens | Mint tokens + get calldata (mint scope) | | get_token_balance | Customer balance & tier | | get_program_analytics | Program metrics | | list_marketplace_offers | P2P trading offers |

Authentication

API key with lsk_ prefix in x-api-key header. Register at loyalspark.online/merchant → AI Agents tab.

Links

- 🌐 loyalspark.online - 📖 API Docs - 🔗 Agent Card
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.