编程助手接入

在 AI 编程助手里使用 Vidgo

通过 MCP 把 Vidgo 文档交给编程助手，再给它一个 API Key。它就能查模型、写接入代码，并替你提交生成任务。

获取 API Key

接入后编程助手可以使用

文档 MCP 服务

检索和阅读 Vidgo 的全部文档、模型参数和 OpenAPI 规范。只读，无需登录。

https://docs.vidgo.ai/mcp

面向 Agent 的文档

llms.txt 文档索引，以及每个页面的 Markdown 版本，供不支持 MCP 的编程助手使用。

https://docs.vidgo.ai/llms.txt

API Key

一个 Key 调用全部模型。放在环境变量里，编程助手就不会把它写进代码。

VIDGO_API_KEY

快速开始：粘贴一段提示词

适用于任意编程助手。它会添加文档 MCP 服务、读取文档索引，并在发起任何计费请求前检查 VIDGO_API_KEY。提示词为英文，编程助手可直接执行。

prompt.md

Set up the Vidgo API (AI image, video, audio, music and 3D generation) for this project.

1. Add the Vidgo docs MCP server (https://docs.vidgo.ai/mcp, HTTP, no auth) with the method for the agent you are:
   - Claude Code: claude mcp add --transport http vidgo https://docs.vidgo.ai/mcp
   - Codex: add [mcp_servers.vidgo] with url = "https://docs.vidgo.ai/mcp" to ~/.codex/config.toml
   - Cursor: add {"mcpServers":{"vidgo":{"url":"https://docs.vidgo.ai/mcp"}}} to .cursor/mcp.json
   - OpenCode: add {"mcp":{"servers":{"vidgo":{"type":"remote","url":"https://docs.vidgo.ai/mcp"}}}} to opencode.json
   If the server only loads after a restart, tell me and continue with step 2.
2. Read https://docs.vidgo.ai/llms.txt. Any docs page is also available as Markdown by adding .md to its URL.
3. Use the API key from the VIDGO_API_KEY environment variable. Never hard-code, log or commit it. If it is not set, ask me to create one at https://vidgo.ai/apis/dashboard/api-key.
4. To generate, POST https://api.vidgo.ai/api/generate/submit with "Authorization: Bearer $VIDGO_API_KEY" and a JSON body {"model": "vendor/model/mode", "input": {...}, "callback_url": "optional"}. Model IDs look like kwaivgi/kling-v4.0/text-to-video. Pick the model and its input fields from its docs page (search the docs MCP, or see https://vidgo.ai/apis/models). Each submit spends credits.
5. Save data.task_id, then GET https://api.vidgo.ai/api/generate/status/{task_id} every 5 seconds until data.status is "finished" or "failed", or use callback_url to get a webhook. Download data.files[].file_url right away; files expire after 24 hours.

When you are done, reply "Vidgo is ready", say whether the MCP server is connected, and wait for my first request.

按编程助手配置

Claude Code

Anthropic 推出的编程助手，支持终端、IDE 和桌面端。

安装 Claude Code 官方 MCP 文档

01 · 添加文档 MCP 服务
Terminal
```
claude mcp add --transport http vidgo https://docs.vidgo.ai/mcp
```
在项目目录中运行。加上 --scope user 可在所有项目中使用。
02 · 检查连接
运行下面的命令，或在 Claude Code 中输入 /mcp，vidgo 应显示为已连接。
```
claude mcp list
```
03 · 设置 API Key
在 API Key 页面创建 Key，然后在启动编程助手的终端里设置：
macOS / Linux
```
# ~/.zshrc or ~/.bashrc
export VIDGO_API_KEY="your-vidgo-api-key"
```
Windows
```
# PowerShell (applies to new terminals)
setx VIDGO_API_KEY "your-vidgo-api-key"
```
Claude Code 运行命令时会继承终端的环境变量。如只想在当前项目使用，可写入本地配置 .claude/settings.local.json（请确认该文件已在 .gitignore 中）：
.claude/settings.local.json
```
{
  "env": {
    "VIDGO_API_KEY": "your-vidgo-api-key"
  }
}
```
04 · 试试这些提示词
- 用 Vidgo 的 Kling 4.0 文生视频生成一段 5 秒视频：雨夜霓虹街道上漂流的纸船，16:9，轮询直到完成，把 MP4 保存到 ./output。
- 在 Vidgo 文档里找一个支持参考图的图像编辑模型，然后写一个 TypeScript 函数提交编辑任务并返回结果 URL。
- 给这个项目加一个 webhook 路由，接收 Vidgo 的 callback_url 回调，并保存已完成任务的文件 URL。
- 对比 Vidgo 上支持 1080p 的图生视频模型，推荐一个适合 10 秒商品短片的模型，并注明出处文档页。
- 写一个脚本读取 prompts.txt，把每一行提交给 Vidgo 的文生图模型，等待全部任务完成并下载图片。
- 先查询我的 Vidgo 积分余额，再估算上面这批任务的费用，确认后再运行。

Codex

OpenAI 推出的编程助手，支持终端、IDE 插件和桌面应用。

安装 Codex 官方 MCP 文档

01 · 添加文档 MCP 服务
~/.codex/config.toml
```
[mcp_servers.vidgo]
url = "https://docs.vidgo.ai/mcp"
```
也可以在终端中运行
```
codex mcp add vidgo --url https://docs.vidgo.ai/mcp
```
Codex 通过 url 直接连接 Streamable HTTP 服务，不需要 mcp-remote。
02 · 检查连接
运行下面的命令，或在 Codex 中输入 /mcp。
```
codex mcp list
```
03 · 设置 API Key
在 API Key 页面创建 Key，然后在启动编程助手的终端里设置：
macOS / Linux
```
# ~/.zshrc or ~/.bashrc
export VIDGO_API_KEY="your-vidgo-api-key"
```
Windows
```
# PowerShell (applies to new terminals)
setx VIDGO_API_KEY "your-vidgo-api-key"
```
Codex 运行命令时会传入 VIDGO_API_KEY。如果你设置了 shell_environment_policy.ignore_default_excludes = false，Codex 会过滤名称含 KEY 的变量，此时请用 shell_environment_policy.set 加回 VIDGO_API_KEY，或关闭该选项。
04 · 试试这些提示词
- 用 Vidgo 的 Kling 4.0 文生视频生成一段 5 秒视频：雨夜霓虹街道上漂流的纸船，16:9，轮询直到完成，把 MP4 保存到 ./output。
- 在 Vidgo 文档里找一个支持参考图的图像编辑模型，然后写一个 TypeScript 函数提交编辑任务并返回结果 URL。
- 给这个项目加一个 webhook 路由，接收 Vidgo 的 callback_url 回调，并保存已完成任务的文件 URL。
- 对比 Vidgo 上支持 1080p 的图生视频模型，推荐一个适合 10 秒商品短片的模型，并注明出处文档页。
- 写一个脚本读取 prompts.txt，把每一行提交给 Vidgo 的文生图模型，等待全部任务完成并下载图片。
- 先查询我的 Vidgo 积分余额，再估算上面这批任务的费用，确认后再运行。

Cursor

AI 代码编辑器，Agent 模式会自动调用 MCP 工具。

下载 Cursor 官方 MCP 文档

01 · 添加文档 MCP 服务
.cursor/mcp.json
```
{
  "mcpServers": {
    "vidgo": {
      "url": "https://docs.vidgo.ai/mcp"
    }
  }
}
```
写在项目的 .cursor/mcp.json；写在 ~/.cursor/mcp.json 则对所有项目生效。
02 · 检查连接
打开 Cursor Settings 的 MCP 部分，确认 vidgo 已启用并列出了工具。
03 · 设置 API Key
在 API Key 页面创建 Key，然后在启动编程助手的终端里设置：
macOS / Linux
```
# ~/.zshrc or ~/.bashrc
export VIDGO_API_KEY="your-vidgo-api-key"
```
Windows
```
# PowerShell (applies to new terminals)
setx VIDGO_API_KEY "your-vidgo-api-key"
```
在终端配置文件或系统环境变量中设置后，重启 Cursor，Agent 的终端才能读到它。
04 · 试试这些提示词
- 用 Vidgo 的 Kling 4.0 文生视频生成一段 5 秒视频：雨夜霓虹街道上漂流的纸船，16:9，轮询直到完成，把 MP4 保存到 ./output。
- 在 Vidgo 文档里找一个支持参考图的图像编辑模型，然后写一个 TypeScript 函数提交编辑任务并返回结果 URL。
- 给这个项目加一个 webhook 路由，接收 Vidgo 的 callback_url 回调，并保存已完成任务的文件 URL。
- 对比 Vidgo 上支持 1080p 的图生视频模型，推荐一个适合 10 秒商品短片的模型，并注明出处文档页。
- 写一个脚本读取 prompts.txt，把每一行提交给 Vidgo 的文生图模型，等待全部任务完成并下载图片。
- 先查询我的 Vidgo 积分余额，再估算上面这批任务的费用，确认后再运行。

OpenCode

开源编程助手，支持终端、桌面端和 IDE。

安装 OpenCode 官方 MCP 文档

01 · 添加文档 MCP 服务

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "servers": {
      "vidgo": {
        "type": "remote",
        "url": "https://docs.vidgo.ai/mcp"
      }
    }
  }
}

也可以在终端中运行（加 --global 对所有项目生效）

opencode mcp add vidgo --url https://docs.vidgo.ai/mcp

把 opencode.json 放在项目根目录。vidgo 服务无需登录，OpenCode 不会走 OAuth 授权。

02 · 检查连接
运行下面的命令，或在 OpenCode 中输入 /mcps。
```
opencode mcp list
```
03 · 设置 API Key
在 API Key 页面创建 Key，然后在启动编程助手的终端里设置：
macOS / Linux
```
# ~/.zshrc or ~/.bashrc
export VIDGO_API_KEY="your-vidgo-api-key"
```
Windows
```
# PowerShell (applies to new terminals)
setx VIDGO_API_KEY "your-vidgo-api-key"
```
OpenCode 运行命令时会继承终端的环境变量，请在启动 opencode 之前设置。
04 · 试试这些提示词
- 用 Vidgo 的 Kling 4.0 文生视频生成一段 5 秒视频：雨夜霓虹街道上漂流的纸船，16:9，轮询直到完成，把 MP4 保存到 ./output。
- 在 Vidgo 文档里找一个支持参考图的图像编辑模型，然后写一个 TypeScript 函数提交编辑任务并返回结果 URL。
- 给这个项目加一个 webhook 路由，接收 Vidgo 的 callback_url 回调，并保存已完成任务的文件 URL。
- 对比 Vidgo 上支持 1080p 的图生视频模型，推荐一个适合 10 秒商品短片的模型，并注明出处文档页。
- 写一个脚本读取 prompts.txt，把每一行提交给 Vidgo 的文生图模型，等待全部任务完成并下载图片。
- 先查询我的 Vidgo 积分余额，再估算上面这批任务的费用，确认后再运行。

文档 MCP 工具

docs.vidgo.ai/mcp 使用 Streamable HTTP 传输，无需认证，提供以下工具：

工具	作用
search_vidgo_api	检索文档，返回匹配的页面、model ID 和代码示例。
query_docs_filesystem_vidgo_api	在文档页面和 OpenAPI 规范上运行 rg、tree、head 等只读命令。
submit_feedback	向 Vidgo 文档团队反馈有误或过时的页面。

面向 Agent 的文档

docs.vidgo.ai/llms.txt 全部文档页面的索引，每页一行简介。docs.vidgo.ai/llms-full.txt 合并为一个文本文件的完整文档。任意页面 + .md 在文档 URL 后加 .md，即可得到该页的 Markdown。vidgo.ai/llms.txt 站点简要索引，指向文档、MCP 服务和模型列表。

编程助手调用的 API

所有生成类模型使用同一套异步流程：用 vendor/model/mode 格式的 model ID 提交任务，然后轮询状态或传入 callback_url。结果文件 24 小时后失效。

提交任务

curl https://api.vidgo.ai/api/generate/submit \
  -H "Authorization: Bearer $VIDGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "kwaivgi/kling-v4.0/text-to-video",
    "input": {
      "prompt": "A paper boat drifting down a rainy neon street, slow dolly shot",
      "duration": 5,
      "aspect_ratio": "16:9"
    }
  }'

查询状态

curl https://api.vidgo.ai/api/generate/status/TASK_ID \
  -H "Authorization: Bearer $VIDGO_API_KEY"

在 AI 编程助手里使用 Vidgo

接入后编程助手可以使用

文档 MCP 服务

面向 Agent 的文档

API Key

快速开始：粘贴一段提示词

按编程助手配置

01 · 添加文档 MCP 服务

02 · 检查连接

03 · 设置 API Key

04 · 试试这些提示词

01 · 添加文档 MCP 服务

02 · 检查连接

03 · 设置 API Key

04 · 试试这些提示词

01 · 添加文档 MCP 服务

02 · 检查连接

03 · 设置 API Key

04 · 试试这些提示词

01 · 添加文档 MCP 服务

02 · 检查连接

03 · 设置 API Key

04 · 试试这些提示词

文档 MCP 工具

面向 Agent 的文档

编程助手调用的 API