mcpField
R
runway-dev-characters

runway-dev-characters

github.com/runwayml开发74129 次安装2 天前更新
代码仓库

关于 runway-dev-characters

帮助开发者将 Runway Characters 集成到应用中，涵盖 Avatar 选择、实时 Session 创建及客户端状态处理。它结合开发文档与 Dev MCP 中的实时 Avatar 和知识文档操作，并要求将 API 密钥保留在服务端。

主要功能

  1. 01检查并选择 Character 或 Avatar
  2. 02通过 Dev MCP 查看 Avatar 状态
  3. 03使用官方 SDK 创建服务端 Session
  4. 04处理连接及 Session 生命周期状态
  5. 05管理 Avatar 和知识文档

适用场景

  1. 01在应用中集成实时对话
  2. 02根据账户中的 Avatar 状态实现集成
  3. 03为自定义 Avatar 管理知识文档

MCP 相关

使用 Dev MCP 查询 Avatar 和知识文档，也可创建、更新或删除这些资源。若需要实时账户信息，则先读取当前记录和工具契约。

安装

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

$npx skills add https://github.com/runwayml/skills --skill runway-dev-characters

安装后在 Claude Code 中输入/runway-dev-characters确认已加载。

详细介绍

Runway 角色

开发者门户将其称为 Characters；API 和 SDK 使用 Avatars。实时 Session 是一次正在进行的对话。如果已安装，请查阅 runway-dev，了解账户设置和共享凭据相关指导。

工作流

  1. 检查应用的通话体验和服务器架构。仅当尚不明确时，询问应使用现有 Character、已记录的预设，还是新创建的自定义 Avatar。
  2. 当实时账户状态或用户的 Character 很重要时，使用 Dev MCP 检查可用的 Avatars 及其状态。不要替换成其他 Avatar，也不要猜测预设 ID。如果用户要求自定义 Avatar，请使用其参考图像和当前 API/MCP 架构。
  3. 遵循最新的 Characters 集成指南 和 SDK 文档。查看 @runwayml/avatars-react README，了解当前的 React 组件、钩子和样式；非 React Web 客户端请使用 @runwayml/avatars。
  4. 使用 @runwayml/sdk 在服务器端创建 Sessions。将 RUNWAYML_API_SECRET 保留在服务器端。遵循当前的 Session 就绪状态和凭据使用流程；仅向浏览器公开浏览器 SDK 所需的一次性连接字段。切勿将 API 密钥发送到浏览器。
  5. 在应用 UI 中处理权限、连接中、活动、失败和已结束状态。根据当前 SDK/API 指南，在拆除时结束或取消 Session。如果一次性凭据已被使用，但连接失败，请创建新的 Session，而不要重复使用这些凭据。
  6. 运行本地检查。实时 Session 可能产生用量费用；仅在用户要求或批准后才为验证而开启。

实时数据与知识

使用可用的 MCP 工具，通过 list_avatars 和 get_avatar 检查实时 Avatars，通过 list_avatar_knowledge_documents 和 get_avatar_knowledge_document 检查知识文档。create_avatar、update_avatar 和 delete_avatar 用于管理 Avatars；相应的 *_avatar_knowledge_document 工具用于管理知识文档。创建 Avatar 后，使用 get_avatar 检查，直到其状态变为 READY 或 FAILED。修改前请读取现有记录和当前工具约定，并在执行破坏性删除前征得用户确认。如果 MCP 不可用，请继续编写可依据文档和现有 ID 实现的应用代码，并仅暂停需要实时账户状态的步骤。

当前文档

评论

支持 Markdown