# Zealy MCP

> Zealy MCP connects your Web3 community directly to AI agents. It lets you manage user rewards, create quests, and track leaderboards for gamification without touching a dashboard. Use it to automate everything from XP distribution to membership verification via natural conversation.

## Overview
- **Category:** collaboration
- **Price:** Free
- **Tags:** community-growth, gamification, web3-marketing, quest-platform, engagement-tools

## Description

Build out your entire web3 community engagement loop using this MCP. Instead of manually logging into the Zealy platform to update stats or add content, your AI agent handles it all through simple commands. You can fetch detailed user profiles by Discord or ETH address, monitor who's on top with real-time leaderboards, and instantly award XP to keep momentum high. Need a new challenge? Create quests, modules, and sprints right from your prompt. This capability is crucial for scaling community marketing efforts. Because you can combine this MCP with others, like a CRM or a messaging platform via Vinkius, you build automations that span multiple tools—all orchestrated by one agent. You get full visibility into every call through Vinkius AI Analytics, so nothing happens in the dark. It’s about taking control of your gamification strategy using conversation.

## Tools

### get_review
Grabs the details of one specific quest submission using its ID.

### get_user
Fetches complete profile information for a user based on their unique Zealy ID.

### list_modules
Lists all existing categories or modules within the community structure.

### list_quests
Provides a comprehensive list of every quest currently active in the community.

### list_reviews
Retrieves all claimed quests that are waiting for moderation review.

### list_secrets
Lists all existing community secrets configured for API use.

### list_sprints
Retrieves a complete list of defined community sprints or campaign periods.

### list_webhooks
Shows all webhooks that are currently active and connected to the platform.

### remove_xp
Manually subtracts experience points from a user's total XP count.

### review_submission
Approves or rejects a submitted quest, updating the user’s status.

### search_users
Finds users within the community by inputting their social media handles.

### update_quest
Modifies details of an existing, published quest.

### update_webhook
Changes the configuration settings for a previously created webhook.

### add_xp
Manually adds experience points to a user's account.

### ban_user
Permanently removes a specified user from the community.

### check_member
Verifies if an individual belongs to the configured community.

### create_quest
Generates and publishes a brand new quest for the entire community.

### create_secret
Sets up a private, protected secret used during API tasks.

### create_webhook
Establishes a new webhook endpoint to sync Zealy events with external systems.

### delete_webhook
Removes an existing, unnecessary webhook connection.

### get_community
Retrieves basic foundational details about a specific Zealy community.

### get_leaderboard
Fetches the current or all-time ranking list of top contributors, filterable by sprint.

### get_referral_code
Retrieves a unique referral code associated with a user for tracking.

## Prompt Examples

**Prompt:** 
```
Search for the user with Discord ID '123456789' in the 'my-community' subdomain.
```

**Response:** 
```
I found the user! Their Zealy UUID is `abc-123-def`. They are currently Level 5 with 1,200 XP. Would you like to see their full profile?
```

**Prompt:** 
```
Add 500 XP to user 'abc-123-def' in 'my-community' for 'Exceptional Content Creation'.
```

**Response:** 
```
Successfully added 500 XP to the user. Their new total is 1,700 XP. The transaction has been logged with the label 'Exceptional Content Creation'.
```

**Prompt:** 
```
List the top 5 users on the leaderboard for the 'my-community' subdomain.
```

**Response:** 
```
Here are the top 5 contributors: 
1. UserA (5,000 XP)
2. UserB (4,850 XP)
3. UserC (4,200 XP)
4. UserD (3,900 XP)
5. UserE (3,750 XP)
Would you like to inspect any of these users specifically?
```

## Capabilities

### Verify Membership Status
Checks if a user belongs to a specific Zealy community.

### Adjust User Experience Points (XP)
Manually adds or removes XP from any user's profile.

### Generate Community Challenges
Creates new quests, modules, and sprints to keep the community engaged.

### Manage Integrations
Sets up or deletes webhooks to sync Zealy events with external databases.

### Audit Community Activity
Retrieves current leaderboards, all-time rankings, and user submission reviews for moderation.

## Use Cases

### Need to reward top users after an AMA event.
The community manager simply tells the agent, 'Give 1000 XP to UserA and 500 XP to UserB.' The agent executes `add_xp` for both accounts instantly. This process is much faster than manually updating profiles one by one.

### A user posts questionable content.
The ops engineer asks the agent, 'Ban this user and notify me.' The agent runs `ban_user`, ensuring immediate removal and logging the action. They don't have to navigate security settings.

### Launching a seasonal campaign.
Instead of creating three quests manually, the marketer prompts: 'Create a new quest called Winter Challenge.' The agent handles `create_quest`, and they can then use `list_sprints` to organize it within a defined period.

### Syncing Zealy data with our internal database.
The developer needs webhooks enabled. They ask the agent, 'Set up a webhook for when any user completes a quest.' The agent executes `create_webhook`, linking Zealy events to an external system.

## Benefits

- Stop logging into the dashboard to update stats. You can now use `add_xp` or `remove_xp` instantly via your agent, making reward distribution fast and auditable.
- Build complex automations that span multiple systems. Chain this MCP with a messaging MCP and a CRM MCP using Vinkius's cross-MCP chaining to complete an entire user journey in one go.
- Maintain high engagement by automating content creation. Use `create_quest` or `update_quest` to launch new campaigns without manual API calls, simply describing the goal to your agent.
- Handle moderation at scale. Instead of manually reviewing submissions, list and process claimed quests using `list_reviews` and then approve them with `review_submission` in a single flow.
- Get immediate user data access. You can use `search_users` or `get_user` to pull detailed profiles by social handle before initiating any action like banning a member via `ban_user`.

## How It Works

The bottom line is you tell your AI what to do with your community, and it handles the API calls automatically.

1. Connect your API key to this MCP in the Vinkius marketplace.
2. Ask your agent a direct question, like 'Find the top 5 contributors on the current leaderboard.'
3. The agent executes the necessary tools and returns structured data about user profiles, quest status, or XP changes.

## Frequently Asked Questions

**How do I give XP using add_xp? **
You simply ask your agent to 'Add 200 XP to user XYZ.' The MCP handles finding the correct Zealy ID and running the `add_xp` tool call directly.

**Can I check if a user is in my community with check_member? **
Yes. You ask your agent to verify membership, and it runs `check_member`. This confirms quickly whether the provided ID belongs to your target community.

**What should I use for recurring campaigns, list_sprints or create_quest? **
Use `list_sprints` first. It shows you all defined campaign periods. Once you know the period name, you can then instruct your agent to 'Create a quest' that targets that specific sprint.

**How do I update my community's settings? **
You can manage webhooks and secrets using `list_webhooks`, `create_webhook`, or `delete_webhook`. These tools control how Zealy talks to your other services.

**How do I manage external data syncs or check existing automation flows using `list_webhooks` and `create_webhook`?**
You first use `list_webhooks` to see all currently configured endpoints. After reviewing the list, you can use `create_webhook` to set up a new connection point for event data to sync with your external systems.

**If I need to find a user by their handle instead of verifying membership, what should I use? Does `search_users` work?**
Yes, you use the `search_users` tool. This allows you to locate specific users using social handles or other identifiers when standard membership checks aren't enough.

**What is the workflow for handling user submissions? Specifically, how do I approve or reject claimed quests using `review_submission`?**
You initiate the review by listing claims via tools like `list_reviews`. Once you identify a submission, use `review_submission` to formally process it and either approve or reject the claim.

**If a user breaks community rules, how do I remove them instantly? Can I use the `ban_user` tool?**
Yes, that's exactly what `ban_user` is for. It immediately removes a specified user from your community roster, ensuring quick moderation action when needed.

**Can I manually award XP to a specific user for their contribution?**
Yes! You can use the `add_xp` tool by providing the community subdomain, the user's UUID, and the amount of XP along with a label and description for the reward.

**How do I find a Zealy user if I only have their Discord ID?**
You can use the `search_users` tool. Simply provide the community subdomain and the `discordId` parameter to retrieve the corresponding Zealy profile and UUID.

**Is it possible to list all pending quest submissions for review?**
Absolutely. Use the `list_reviews` tool to fetch submissions that need attention. You can then use `review_submission` to approve or reject them directly.