忠诚的MCP服务器
Loyalteez的模型上下文协议(MCP)服务器-使AI助手能够设计忠诚度计划、创建活动、跟踪奖励和访问全面的文档。
](https://www.npmjs.com/package/@loyalteez/mcp-server)    
概述
Loyalteez MCP服务器提供AI工具(Claude、ChatGPT、Cursor等),可以直接访问Loyaltees的忠诚度基础设施。通过自然对话设计整个程序,创建自定义事件,跟踪奖励,并访问完整文档——所有这些都是通过MCP协议实现的。
首个集成原生人工智能的忠诚度平台 -使AI助手能够通过自然对话建立完整的忠诚度集成。
特性
- 30工具:忠诚度计划集成的综合工具集
- 11资源:参考资料,包括合同、SDK文档、错误代码等
- 程序设计:基于人工智能的忠诚度计划生成,包括事件结构、层次和实施代码
- 活动管理:使用通道约束和域验证创建和跟踪无限灵活的自定义事件
- 用户身份:将平台身份解析到Loyalteez钱包
- 参与服务:条纹跟踪、排行榜、成就和活动记录
- Webhook支持:验证签名并为任何框架生成接收者代码
- 移动示例:React Native、iOS、Android和Flutter集成示例
- 代码生成:使用TypeScript类型、错误处理和测试生成完整的实现
- 文档访问:完整的开发人员文档作为MCP资源提供(延迟加载和缓存)
- 平台支持:Discord、Telegram、Web、Shopify、游戏等
范围
MCP服务器专注于 第三方开发者集成 能力。对于品牌管理功能(条纹结账、DNS验证、分析),请使用 合作伙伴门户。参见 SCOPE.md 详细的范围定义。
安装
选项1:从npm安装(推荐)
npm install -g @loyalteez/mcp-server或在本地安装:
npm install @loyalteez/mcp-server选项2:从GitHub安装
# Clone the repository
git clone https://github.com/Alpha4-Labs/loyalteez-mcp.git
cd loyalteez-mcp
# Install dependencies
npm install
# Build the project
npm run build内置服务器将在 dist/index.js.
用法
使用Claude桌面版
添加到您的Claude Desktop MCP配置中:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 视窗:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
如果通过npm安装:
{
"mcpServers": {
"loyalteez": {
"command": "npx",
"args": ["@loyalteez/mcp-server"],
"env": {
"LOYALTEEZ_NETWORK": "mainnet",
"LOYALTEEZ_BRAND_ID": "0x47511fc1c6664c9598974cb112965f8b198e0c725e"
}
}
}
}如果从GitHub安装:
{
"mcpServers": {
"loyalteez": {
"command": "node",
"args": ["/absolute/path/to/loyalteez-mcp/dist/index.js"],
"env": {
"LOYALTEEZ_NETWORK": "mainnet",
"LOYALTEEZ_BRAND_ID": "0x47511fc1c6664c9598974cb112965f8b198e0c725e"
}
}
}
}环境变量
LOYALTEEZ_NETWORK:要使用的网络-mainnet(默认)或testnetLOYALTEEZ_BRAND_ID:您的品牌钱包地址(可选,也可按工具提供)
可用工具
程序设计
- 忠诚度_设计_程序:根据上下文设计完整的忠诚度计划
活动管理
- 忠诚_创造_事件:创建单个自定义事件
- loyalteezcreate_events_batch:一次创建多个事件
- 忠诚追踪事件:触发任何事件并奖励用户
- loyalteez_get-event_config:获取品牌的所有配置事件
- 忠诚_博客_活动:在单个请求中提交多个事件
- 忠诚_行政奖励:手动奖励用户(mod/admin触发)
用户身份与平衡
- 忠诚度_解决方案_用户:将平台身份转换为Loyalteez钱包
- 忠诚_用户_平衡:获取用户的LTZ余额和交易历史记录
- 忠诚_检查_资格:检查用户是否可以领取活动奖励
- loyalteez_get_user_stats:获取全面的用户统计数据
参与服务
- 忠诚_破裂_检查:使用乘数进行连续登记
- loyalteez_get-straine_status:获取当前连胜状态
- 忠诚_忠诚_破裂_巨石:申请里程碑奖金(7、30、100、365天)
- 忠诚_活动:跟踪语音时间、消息、每日上限反应
- 忠诚_计算_奖励:使用角色乘数计算最终奖励
- loyalteez_get_排行榜:按指标获取排名排行榜
- 忠诚度_更新_排行榜_统计数据:奖励后更新用户统计数据
社交功能
- loyaltee_create_drop:创建限时奖励空投
- loyaltees_laim_drop:处理用户的掉线索赔
- 忠诚_过程_第三方_聚会_活动:处理Mee6、奥术、Tatsu等事件。
奖金和赎回
- loyalteez_list_perks:为品牌获得可用的福利
- 忠诚_检查_员工_资格:检查用户是否可以申请特定福利
- 忠诚_优惠:为用户兑换福利
成就
- 忠诚_用户_成就:获取用户的所有成就
- 忠诚_更新_成就_进步:更新取得成就的进展
交易
- 忠诚交易:执行无气体区块链交易
可用资源
文献资源
所有开发人员文档都可以作为MCP资源使用,URI如下:
loyalteez://docs/architectureloyalteez://docs/api/rest-apiloyalteez://docs/integrations/discordloyalteez://docs/guides/custom-events- …以及更多
静态资源
- 合同:
loyalteez://contracts/ltz-token,loyalteez://contracts/perk-nft,loyalteez://contracts/points-sale,loyalteez://contracts/all - 网络:
loyalteez://network/config-Soneium网络配置 - 事件类型:
loyalteez://events/standard-标准事件类型参考(包括通道约束和域验证) - 共享服务:
loyalteez://shared-services/endpoints-游戏化服务的API端点 - OAuth提供者:
loyalteez://platforms/mappings-OAuth提供者ID格式 - 错误代码:
loyalteez://errors/codes-完整的HTTP状态代码和错误响应参考 - 错误处理:
loyalteez://errors/handling-错误处理模式和最佳实践 - 速率限制:
loyalteez://rate-limits/endpoints-具有重置期的端点速率限制 - 利率限制策略:
loyalteez://rate-limits/strategies-处理速率限制的代码示例 - SDK方法:
loyalteez://sdk/methods-JavaScript SDK方法参考及示例 - SDK示例:
loyalteez://sdk/examples-React、Vue、Next.js的SDK使用示例
示例用法
设计一个Discord程序
User: "Design a loyalty program for my developer Discord with events for quality contributions"
AI: [Uses loyalteez_design_program tool]
Returns: Complete program with events, implementation code, and best practices创建自定义事件
User: "Create 5 events for my Telegram trading community"
AI: [Uses loyalteez_create_events_batch tool]
Returns: All created events + Telegram bot implementation code径赛
User: "Track a helpful_answer event for Discord user 123456789"
AI: [Uses loyalteez_track_event tool]
Returns: Success, reward amount, new balance, transaction hash带条纹的日常入住
User: "Set up daily check-ins with streak bonuses for my Telegram bot"
AI: [Uses loyalteez_streak_checkin tool]
Returns: Current streak, multiplier, reward amount, next milestone检查用户余额
User: "What's the balance for user discord_123456789?"
AI: [Uses loyalteez_get_user_balance tool]
Returns: Current balance, wallet address, transaction history创建奖励掉落
User: "Create a reaction drop for 50 LTZ, first 100 users"
AI: [Uses loyalteez_create_drop tool]
Returns: Drop ID, claim URL, embed data for posting建筑
AI Assistant (Claude/ChatGPT)
↓ MCP Protocol
Loyalteez MCP Server
↓ HTTP API
Loyalteez APIs
- Event Handler (api.loyalteez.app)
- Shared Services (services.loyalteez.app)
- Pregeneration (register.loyalteez.app)发展
构建
npm run build类型检查
npm run typecheck测试
npm test看 测试 详情请参阅第节。
项目结构
loyalteez-mcp/
├── src/
│ ├── index.ts # Entry point
│ ├── server.ts # MCP server setup
│ ├── tools/ # MCP tools
│ │ ├── events.ts
│ │ ├── program-design.ts
│ │ ├── identity.ts
│ │ ├── engagement.ts
│ │ ├── user.ts
│ │ ├── transactions.ts
│ │ ├── drops.ts
│ │ ├── integrations.ts
│ │ ├── perks.ts
│ │ └── achievements.ts
│ ├── resources/ # MCP resources
│ │ ├── docs.ts
│ │ ├── contracts.ts
│ │ ├── network.ts
│ │ ├── event-types.ts
│ │ ├── shared-services.ts
│ │ ├── oauth.ts
│ │ ├── errors.ts
│ │ ├── rate-limits.ts
│ │ └── sdk.ts
│ ├── utils/ # Utilities
│ │ ├── api-client.ts
│ │ ├── brand-id.ts
│ │ ├── doc-loader.ts
│ │ ├── doc-index.ts
│ │ └── validation.ts
│ └── types/ # TypeScript types
│ └── index.ts
├── tests/ # Test suite
│ ├── brand-id.test.ts
│ ├── validation.test.ts
│ ├── resources.test.ts
│ ├── tools.test.ts
│ ├── api-client.test.ts
│ ├── integration.test.ts
│ └── README.md
├── examples/ # Usage examples
└── README.mdAPI终点
MCP服务器与这些Loyalteez API交互:
- 事件处理器:
https://api.loyalteez.app(主网)/https://api.loyalteez.xyz(测试网) - 共享服务:
https://services.loyalteez.app(主网)/https://services.loyalteez.xyz(测试网) - 前一代:
https://register.loyalteez.app(主网)/https://register.loyalteez.xyz(测试网)
BrandId配置
这 brandId 大多数操作都需要参数,但可以通过两种方式提供:
- 环境变量 (推荐):套装
LOYALTEEZ_BRAND_ID在您的环境中 - 工具参数:提供
brandId作为每个工具调用的参数
如果两者都没有提供,工具将返回一条有用的错误消息,解释如何设置它。
安全
- 不需要API密钥-使用公共密钥
brandId标识符 - 所有输入均已在服务器端验证
- 限速意识(记录的限制)
- 支持测试网/主网分离
- BrandId可以通过环境变量设置,方便使用
文档
完整文档可作为MCP资源提供。访问方式:
loyalteez://docs/{path}例如:
loyalteez://docs/architecture-系统架构loyalteez://docs/api/rest-api-REST API参考loyalteez://docs/integrations/discord-Discord集成指南
测试
MCP服务器包括一个全面的测试套件,用于验证所有工具和模式。
运行测试
# Run all tests
npm test
# Run tests in watch mode (for development)
npm run test:watch
# Run tests with coverage report
npm run test:coverage测试覆盖率
测试包括:
- 品牌ID解析:环境变量与参数处理
- 输入验证:所有验证工具(brandId、电子邮件、eventType等)
- 资源加载:所有MCP资源类型(合同、网络、事件等)
- 工具注册:所有24+工具均已正确注册
- 工具架构:模式验证和brandId可选性
- API客户端:所有API方法和错误处理
- 服务器集成:服务器初始化和配置
看 tests/ 详细测试文件目录 tests/README.md 用于测试文档。
故障排除
未找到品牌ID
如果您看到“BrandId是必需的,但未提供”:
- 集
LOYALTEEZ_BRAND_ID环境变量,或 - 提供
brandId作为工具调用的参数
未找到工具
确保您已经构建了项目:
npm run build资源未找到
资源在服务器启动时加载。确保:
- 文档文件存在于预期位置
- 资源URI与预期格式匹配(例如。,
loyalteez://docs/...)
贡献
这是Alpha4实验室的内部工具。如有任何问题或疑问,请联系Loyalteez团队。
许可证
麻省理工学院
