mcpField
S
stream

stream

github.com/getstream开发201.6k 次安装今天更新
代码仓库

关于 stream

Stream 技能为使用 Stream API 和 SDK 构建 Chat、Video、Activity Feeds 与 Moderation 功能的 Agent 和开发者提供指引。它将应用开发任务分配给平台专属技能,并通过 getstream 命令行处理账户操作、API 调用、文档查询和 Agent 设置。

主要功能

  1. 01按平台路由专属技能
  2. 02getstream 命令行指引
  3. 03API 与文档查询
  4. 04Stream Agents 设置指引

适用场景

  1. 01为特定平台应用选择技能
  2. 02查询或修改 Stream 应用数据
  3. 03查找 Stream 文档
  4. 04配置 Stream Agents 应用

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/getstream/agent-skills --skill stream

安装后在 Claude Code 中输入/stream确认已加载。

附带文件ai-backend-contract.mdsendbird-data-migration.md

详细介绍

Stream

Stream(getstream.io)提供 API 和 SDK,可为应用添加 Chat、Video(通话和直播)、Activity Feeds 和 Moderation。Stream 账户包含组织;组织包含应用;每个应用有一个或多个 API key + secret 对。所有数据——用户、频道、通话、信息流——都限定在单个应用范围内。客户端 SDK 支持 React、iOS、Android、React Native、Flutter、Unity 和 Unreal;服务端 SDK 可生成用户令牌,并调用相同的 API。大多数客户端 SDK 都提供 UI 套件。

Stream Agents 在 Stream 的后端运行语音和文本 AI Agent。Agent 是由普通文件组成的文件夹(agents/<name>/agent.yaml、指令、防护规则、知识、技能、模拟),通过 getstream agents 同步;会话则通过 Agents SDK(Web 端使用 @stream-io/calypso)打开。会话中的对话是一个 Chat 频道,语音则是一次 Video 通话,因此围绕 Agent 构建的应用和其他应用一样,也是 Chat 和 Video 应用。

CLI

getstream CLI 是处理账户和数据相关工作的基础工具:进行身份验证、为项目完成入门设置(组织、应用、凭据)、调用任何 API 端点、获取凭据、生成用户令牌、阅读文档,以及安装其他 Stream 技能。不要凭记忆操作——运行 getstream -h 和 getstream <command> -h,并遵循命令输出的说明。

安装方法(如果尚未安装):

curl -fsSL https://getstream.io/cli.sh | bash
getstream --version

用户也可以从 getstream.io/cli 安装 CLI。

getstream agents 命令仅在测试版中提供,其版本号由日期和提交组成(YYYY-MM-DD-<commit>),而非 semver。稳定版会对这些命令返回“agents unavailable”。请在稳定版上安装测试版:

curl -fsSL https://getstream.io/cli/beta/install.sh | bash

路由

按顺序匹配,匹配到的第一个选项优先:

  1. 开发特定平台的应用(构建、集成、审计、升级):使用该平台专用技能。

    • stream-react(React / Next.js)
    • stream-react-native(React Native / Expo)
    • stream-swift(iOS / SwiftUI / UIKit)
    • stream-android(Kotlin / Compose)
    • stream-flutter
    • stream-unity(Chat 和 Video)
    • stream-unreal(仅 Chat)

    使用 getstream skills <name> 安装缺失的技能,然后按其说明操作。对于 Web 应用或通用应用,选择 stream-react。框架优先于操作系统:“面向 iOS 的 Unreal 聊天应用”应选择 stream-unreal。

    基于 Stream Agents 构建的应用也属于平台开发,即使请求中只提到“agent”或“语音 agent”。从 Agent 的文件夹配置 Agent,并使用 getstream docs agents/<sdk>(javascript、ios、android、flutter)查阅文档;同时使用平台技能构建应用:其 Chat UI 套件负责呈现会话对话,其 Video SDK 负责处理通话。React Native、Unity 和 Unreal 没有 Agents 客户端 SDK——构建前请告知用户。

  2. **将 Feeds v2 迁移到 v3:**使用 stream-feeds-migration 技能。

  3. **从 Sendbird 迁移:**使用平台专用技能迁移代码;如需迁移数据本身(用户、频道、消息历史记录),请阅读 sendbird-data-migration.md。

  4. **文档 /“X 是如何工作的”问题:**使用 getstream docs 命令。在类似 $(getstream docs <id>) 的命令替换中,不要添加 2>&1。所需路径会输出到 stdout。

  5. 查询或修改应用数据(“列出频道”“有没有被标记的消息?”、一次性 API 调用):使用 getstream api 命令。

  6. **确实无法判断:**询问用户。

评论

支持 Markdown