article
README
🚀 Twitch MCP 服务器
Twitch MCP 服务器是一个与 Twitch API 交互的模型上下文协议(MCP)服务器,它借助 Twitch Helix API,能够获取频道信息、流详情、游戏数据等,为用户提供丰富的 Twitch 相关数据。
🚀 快速开始
Twitch MCP 服务器能为你提供丰富的 Twitch 数据,使用前请确保满足先决条件,完成安装和配置。安装完成后,运行命令即可启动服务器。
✨ 主要特性
- 频道信息获取:获取频道信息(个人资料、描述、创建日期等)。
- 直播信息获取:获取直播信息(标题、游戏、观众数、开始时间等)。
- 热门游戏列表:获取热门游戏列表。
- 类别/游戏搜索:搜索类别/游戏。
- 频道搜索:搜索频道。
- 实播流获取:获取实播流(按游戏和语言筛选)。
- 表情包获取:获取全球表情包。
- 聊天徽章获取:获取全局聊天徽章。
- 用户信息获取:获取用户信息。
- 频道片段获取:获取指定频道的片段。
- 视频设置获取:获取视频设置。
- 视频评论获取:从存档视频中获取评论(使用 GraphQL API)。
📦 安装指南
先决条件
- Node.js(推荐 v18 或更高版本)
- Twitch 开发者账户
- Twitch API 客户端 ID 和客户端密钥
- Twitch GraphQL 客户端 ID(用于视频评论功能)
安装步骤
使用 npm 安装包:
npm install @mtane0412/twitch-mcp-server
💻 使用示例
基础用法
安装完成后,运行以下命令启动服务器:
npx @mtane0412/twitch-mcp-server
高级用法
调试
由于 MCP 服务器通过 stdio 通信,调试可能具有挑战性。我们推荐使用 MCP Inspector,它作为包脚本可用:
npm run inspect
Inspector 将提供一个访问浏览器调试工具的 URL。
📚 详细文档
配置
- 在 Twitch 开发者控制台 创建一个新的应用程序。
- 设置以下环境变量:
# macOS/Linux
export TWITCH_CLIENT_ID="your_client_id"
export TWITCH_CLIENT_SECRET="your_client_secret"
# Windows (PowerShell)
$env:TWITCH_CLIENT_ID="your_client_id"
$env:TWITCH_CLIENT_SECRET="your_client_secret"
或者,你可以创建一个 .env 文件:
TWITCH_CLIENT_ID=your_client_id
TWITCH_CLIENT_SECRET=your_client_secret
📄 许可证
本项目采用 MIT License。
微信扫一扫