项目简介
KickMCP服务器是一个基于 Model Context Protocol (MCP) 标准构建的后端服务,专注于为 Kick 直播平台提供数据和功能接口。它允许AI应用 (如Cursor, Claude, Trae等) 通过标准化的JSON-RPC协议,安全、可扩展地访问Kick平台的各项能力,例如聊天互动、频道信息、流媒体控制等。
主要功能点
- 完整的Kick API集成: 提供对Kick平台聊天、用户、频道、流媒体等核心API的访问能力。
- MCP标准兼容: 采用JSON-RPC 2.0协议通信,支持身份验证和可扩展的API端点,符合MCP协议规范。
- 现代TypeScript codebase: 使用严格类型和模块化结构,代码质量高,易于维护和扩展。
- 内置诊断工具: 提供MCP Inspector,方便开发者验证服务器健康状态和MCP兼容性。
- 轻松集成AI工具: 兼容Cursor, Claude, Trae等MCP客户端,并提供详细的集成示例。
安装步骤
- 环境准备: 确保已安装 Node.js v18.x 或更高版本 和 npm。
- 克隆仓库: 从GitHub克隆 KickMCP 仓库到本地:
git clone https://github.com/NosytLabs/KickMCP.git cd KickMCP - 安装依赖: 在项目根目录下运行:
npm install - 配置环境变量:
- 复制 '.env.example' 文件并重命名为 '.env'。
- 访问 Kick开发者门户 创建应用,设置重定向URI为 'http://localhost:3000/kick_callback'。
- 将从Kick开发者门户获取的 'CLIENT_ID' 和 'CLIENT_SECRET' 填入 '.env' 文件,并设置 'TOKEN_ENCRYPTION_KEY' 用于token加密存储。
服务器配置
MCP客户端连接 KickMCP 服务器时,需要配置服务器启动命令 (command) 及其参数 (args)。以下是 KickMCP 服务器的推荐配置信息 (JSON格式):
{ "serverName": "KickMCP", "command": "npx", "args": [ "@nosytlabs/kickmcp@latest" ], "description": "启动 KickMCP 服务器,通过 stdin/stdout 进行 JSON-RPC 通信。", "notes": "请确保已安装 Node.js 和 npm,并已配置好 .env 文件中的 Kick API 凭据。" }
参数说明:
- serverName: 服务器名称,可自定义。
- command: 启动服务器的命令,这里使用 'npx' 直接运行 npm 包。
- args: 命令参数,指定要运行的 npm 包 '@nosytlabs/kickmcp@latest'。
- description: 服务器配置的描述信息,方便用户理解。
- notes: 配置注意事项,提醒用户环境依赖和配置步骤。
基本使用方法
-
启动服务器: 在项目根目录下运行以下命令启动 KickMCP 服务器:
npm run dev # 开发模式 或 npm run start # 生产模式 (需先运行 npm run build)服务器默认监听 3000 端口,并通过标准输入/输出 (stdin/stdout) 接收和发送 JSON-RPC 请求。
-
MCP客户端集成: 配置您的MCP客户端 (如Cursor, Claude, Trae等),连接到 KickMCP 服务器。客户端将通过 JSON-RPC 协议与服务器通信,调用 Kick API 的各项功能。
-
身份验证: 部分API接口需要进行身份验证。使用 'kickAuth.initiateLogin' 方法开始OAuth 2.0授权流程,获取授权码,再使用 'getAccessToken' 方法交换访问令牌。
-
调用API方法: 通过MCP客户端发送 JSON-RPC 请求,调用 KickMCP 服务器提供的各种API方法,例如 'getChannelInfo' 获取频道信息,'sendChatMessage' 发送聊天消息等。详细的API方法列表和参数说明请参考项目文档。
信息
分类
网页与API