使用说明
哇,mcp
社区建设 模型上下文协议(MCP)服务器 为了 Whop.com API公司。它使AI助手(Claude、Cursor等)能够全面管理您的Whop业务——支付、会员资格、产品、促销代码、附属公司等。
✨ 特性
- 🔐 通过环境变量实现安全的API密钥身份验证
- 📦 具有严格类型安全的完整TypeScript
- 🔄 自动重试和速率限制处理
- 🛡️ 全面的错误处理(401403404429)
- 🚀 适用于Claude Desktop、Cursor和任何兼容MCP的客户端
- 📡 stdio传输(作为CLI二进制或子进程工作)
⚙️ 快速开始
在VS代码中安装
只需单击一下即可在VS Code中安装whop-mcp服务器:
注: 替换
YOUR_WHOP_API_KEY_HERE使用Whop开发者仪表板中的实际公司API密钥。
在Claude桌面中安装
添加到您的Claude Desktop配置文件中:
macOS/Linux: ~/.config/claude/claude_desktop_config.json
视窗: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"whop": {
"command": "npx",
"args": ["-y", "@furkankoykiran/whop-mcp"],
"env": {
"WHOP_API_KEY": "YOUR_WHOP_API_KEY_HERE"
}
}
}
}
在游标中安装
添加到光标MCP设置(Cursor Settings -> MCP Servers):
{
"whop": {
"command": "npx",
"args": ["-y", "whop-mcp"],
"env": {
"WHOP_API_KEY": "YOUR_WHOP_API_KEY_HERE"
}
}
}
🔑 获取API密钥
- 首选 https://whop.com/dashboard/developer
- 点击 创建 在 公司API密钥 部分
- 为您的密钥命名(例如“Claude Integration”)
- 选择适当的权限(付款、会员资格、产品等)
- 把钥匙抄下来,你再也见不到了!
💰 可用工具
💰 支付与金融
| 工具 | 说明 |
|---|---|
list_payments |
使用筛选器(状态、产品、日期范围、分页)列出付款 |
get_payment |
获取特定付款的完整详细信息 |
refund_payment |
全额或部分退款 |
retry_payment |
重试失败的付款尝试 |
void_payment |
撤销未结清/未收款项 |
get_financial_summary |
高级收入、退款和费用汇总 |
🪪 会员资格和许可证
| 工具 | 说明 |
|---|---|
list_memberships |
列出带有过滤器的成员资格(状态、产品、用户、有效性) |
get_membership |
获取完整的会员详细信息,包括许可证密钥和到期时间 |
validate_license |
验证许可证密钥并检查其成员资格是否处于活动状态 |
add_free_days |
通过增加免费天数来延长会员资格 |
cancel_membership |
在期间结束时取消会员资格 |
terminate_membership |
立即撤销会员资格 |
update_membership |
更新成员资格的元数据 |
📦 产品与目录
| 工具 | 说明 |
|---|---|
list_products |
列出所有有计划和体验的产品 |
get_product |
获取完整的产品详细信息、计划和体验 |
create_product |
创建新产品 |
update_product |
更新产品名称、可见性或描述 |
delete_product |
永久删除产品 |
list_plans |
列出产品的所有定价方案 |
🎟️ 促销代码和折扣
| 工具 | 说明 |
|---|---|
list_promo_codes |
列出所有带有可选状态过滤器的促销代码 |
get_promo_code |
获取特定促销代码的详细信息 |
create_promo_code |
创建新的折扣码(%或$折扣) |
update_promo_code |
更新现有促销代码(状态、到期等) |
delete_promo_code |
永久删除促销代码 |
🤝 联盟成员
| 工具 | 说明 |
|---|---|
list_affiliates |
列出所有关联公司的佣金和收益数据 |
get_affiliate |
获取特定联盟的详细统计数据 |
get_affiliate_summary |
将联盟计划绩效与表现最佳者汇总 |
👥 客户与评价
| 工具 | 说明 |
|---|---|
get_user |
通过用户名或用户ID查找Whop用户 |
search_users_by_email |
通过电子邮件地址查找客户 |
list_reviews |
使用可选的星级过滤器获取客户评论 |
get_review_stats |
综合评价统计(平均评分、分布) |
▶️ 示例提示
连接后,您可以询问您的AI助手:
- “显示过去30天的所有付款”
- “退款支付_123abc”
- “为会员mem_456def添加7天免费时间”
- “创建一个名为SUMMER20的20%折扣促销代码,该代码将于2025年12月31日到期”
- “我的平均客户评价是多少?”
- “按收入计算,我的前五大附属公司是谁?”
- “验证许可证密钥ABC-1234-XYZ”
🔧 发展
# Install deps
npm install
# Run in dev mode (auto-reload)
npm run dev
# Build
npm run build
# Test manually
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | WHOP_API_KEY=test node dist/index.js
🤝 贡献
欢迎投稿!请参阅 贡献.md 作为指导方针。
📄 许可证
该项目根据 MIT许可证.
⚠️ 免责声明: 这是一个由社区主导的项目 非 Whop.com的官方产品。它不隶属于Whop.com,也不受Whop.com的认可或支持。在执行退款或终止会员资格等操作之前,始终在非生产环境中进行测试。
