Twitch MCP Server 使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现，它将 Twitch 聊天功能集成到 MCP 协议中。通过该服务器，LLM 客户端可以调用预定义的 Tool，向指定的 Twitch 频道发送聊天消息。

主要功能点

消息发送 Tool: 提供 'sendMessageToChat' Tool，允许 LLM 客户端向指定的 Twitch 频道发送文本消息。

安装步骤

本地构建: 由于该项目尚未发布到 Maven Central，你需要克隆仓库到本地并使用 Maven 进行构建和安装到本地 Maven 仓库 ('.m2' 目录)。

git clone https://github.com/TomCools/twitch-mcp.git
cd twitch-mcp
mvn install

安装 JBang (如果尚未安装): 根据 JBang 官方文档安装 JBang。JBang 用于便捷地运行 Java 应用。

服务器配置

MCP 客户端 (例如 MCP Inspector 或 Claude) 需要配置连接到 Twitch MCP Server 的信息。以下是 JSON 格式的配置示例，你需要根据你的 Twitch 频道信息进行修改。

{
  "mcpServers": {
    "twitch-mcp-server": {  //  服务器名称，可以自定义
      "command": "jbang",   //  启动服务器的命令，这里使用 JBang
      "args": [             //  启动参数
        "--quiet",         //  JBang 参数，静默模式启动
        "-Dtwitch.channel=YOUR_CHANNEL_NAME",  //  Twitch 频道名称，替换为你的频道名
        "-Dtwitch.auth=YOUR_API_KEY",     //  Twitch API 密钥，替换为你的 API 密钥
        "be.tomcools:twitch-mcp:1.0.0-SNAPSHOT:runner" //  指定要运行的 JAR 文件，groupId:artifactId:version:classifier
      ]
    }
  }
}

配置参数说明:

'twitch.channel': 必填。你要连接的 Twitch 频道名称。请替换 'YOUR_CHANNEL_NAME' 为实际的频道名称。
'twitch.auth': 必填。你的 Twitch API 密钥 (OAuth token)。请替换 'YOUR_API_KEY' 为有效的 Twitch API 密钥。你可以在 Twitch Developer 网站获取。

重要提示:

你需要在 Twitch Developer 网站创建并获取 Twitch API 密钥，并确保该密钥具有发送聊天消息的权限。
首次运行前，请确保已成功执行 'mvn install' 命令，将项目安装到本地 Maven 仓库。

基本使用方法

启动 MCP Inspector (推荐): 运行 'npx @modelcontextprotocol/inspector' 启动 MCP Inspector。
配置 MCP 服务器: 在 MCP Inspector 中，根据上述 "服务器配置" 部分的内容，添加名为 'twitch-mcp-server' 的 MCP 服务器配置。
连接服务器: MCP Inspector 会自动尝试连接到配置的 MCP 服务器。
调用 Tool: 在 MCP Inspector 中，你应该能看到 'sendMessageToChat' 这个 Tool。选择该 Tool，输入 'message' 参数 (要发送的 Twitch 消息内容)，然后执行 Tool。
查看结果: 如果 Tool 执行成功，你将在 Twitch 频道中看到发送的消息。

Claude Desktop 配置 (可选):

如果你使用 Claude Desktop，可以将上述 "服务器配置" 中的 JSON 代码添加到 'claude_desktop_config.json' 文件中，重启 Claude Desktop 后，'sendMessageToChat' Tool 将会出现在 Claude 的工具列表中。

关键词