使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型(LLM)客户端提供视频生成相关的上下文信息和功能。它通过集成 Vidu 视频生成 API,使得 LLM 能够调用工具来完成图像到视频的转换、查询视频生成状态以及上传图片资源等任务。

主要功能点

  • 图像转视频: 将静态图片转换为动态视频,支持自定义视频时长、分辨率、模型选择等参数。
  • 查询生成状态: 允许用户通过任务ID查询视频生成的进度和状态,方便追踪视频生成过程。
  • 图片上传: 提供图片上传功能,为图像转视频工具准备图片资源。

安装步骤

  1. 克隆仓库

    git clone https://github.com/el-el-san/vidu-mcp-server.git
    cd vidu-mcp-server
  2. 安装依赖

    npm install
  3. 配置API密钥

    • 复制 '.env.template' 文件并重命名为 '.env'。
    • 打开 '.env' 文件,将 'VIDU_API_KEY=your_api_key_here' 中的 'your_api_key_here' 替换为您的 Vidu API 密钥。您需要访问 Vidu官网 获取 API 密钥。
  4. 构建项目

    npm run build
  5. 启动服务器

    npm start

    服务器启动后,将监听标准输入/输出,等待 MCP 客户端的连接和请求。

服务器配置

MCP 客户端需要配置以下信息以连接到 Vidu MCP 服务器:

{
  "serverName": "vidu-mcp-server",
  "command": "npm",
  "args": ["start"]
}

配置参数说明:

  • 'serverName': 服务器名称,可以自定义,例如 "vidu-mcp-server"。
  • 'command': 启动服务器的命令,这里使用 'npm'。
  • 'args': 启动命令的参数,这里使用 '["start"]' 来运行 'npm start' 命令。

注意: 请确保您的运行环境中已安装 Node.js 和 npm,并且能够访问互联网,以便服务器可以与 Vidu API 进行通信。

基本使用方法

本 MCP 服务器提供以下工具,LLM 客户端可以通过 JSON-RPC 请求调用这些工具:

  1. image-to-video: 图像转视频工具。

    • 参数包括 'image_url' (图片URL), 'prompt' (视频描述文本), 'duration' (视频时长), 'model' (模型名称), 'resolution' (分辨率), 'movement_amplitude' (运动幅度), 'seed' (随机种子) 等。
  2. check-generation-status: 查询生成状态工具。

    • 参数为 'task_id' (任务ID),用于查询指定视频生成任务的状态。
  3. upload-image: 图片上传工具。

    • 参数包括 'image_path' (本地图片文件路径), 'image_type' (图片文件类型)。

客户端需要根据 MCP 协议规范,构造 JSON-RPC 请求发送到服务器的标准输入,服务器会将处理结果通过标准输出以 JSON-RPC 响应的形式返回。 具体请求参数和响应格式请参考仓库 'README.md' 文件中 "Tools" 部分的描述和 'index.ts' 代码中的工具定义。

信息

分类

AI与计算