跳转到内容

MCP 工具与资源

本参考由正在运行的 MCP 服务器自动生成

工作流

AI 代理应遵循以下工作流来运行流水线:

  1. list_pipelines —— 发现可用的流水线
  2. get_pipeline_schema —— 获取所选流水线的输入 schema
  3. request_upload —— 上传所需的任何文件(图像、视频、音频)
  4. run_pipeline —— 用所需输入运行流水线
  5. get_pipeline_run_status —— 查询结果(或等待实时通知)

工具

list_pipelines

列出所有可用的 AI 视频/图像流水线。为每条活跃流水线返回名称、slug、描述、类别、积分成本以及所需的提供方。

参数:


get_pipeline_schema

获取某条特定流水线的输入 schema。返回描述必填和可选输入字段的 JSON Schema。在运行流水线之前使用它,以了解需要哪些输入。

参数:

名称类型必填描述
pipeline_slugstring流水线的 slug 标识符(例如 ‘image-generator’、‘video-generator’)

run_pipeline

按 slug 运行一条 AI 流水线,并传入给定的输入。使用 list_pipelines 发现可用流水线,使用 get_pipeline_schema 查看所需输入。返回一个用于跟踪状态的运行 ID。

参数:

名称类型必填描述
inputobject以 JSON 对象形式提供的流水线输入字段。使用 get_pipeline_schema 查看每条流水线的必填字段。
pipeline_slugstring要运行的流水线的 slug 标识符(例如 ‘image-generator’、‘video-generator’)

get_pipeline_run_status

查询一次流水线运行的状态。返回状态(pending/running/completed/failed)、输出数据、错误信息、时间戳以及生成的素材 URL。

参数:

名称类型必填描述
run_idstring由 run_pipeline 返回的流水线运行 ID

request_upload

为一个文件请求预签名的 S3 上传 URL。用于需要文件 URL 的流水线输入(例如图像、视频、音频)。

两步上传流程:

  1. 用 filename 和 content_type 调用此工具,以获取一个预签名上传 URL 和最终素材 URL
  2. 将文件内容 PUT 到 upload_url(预签名,5 分钟后过期)
  3. 运行流水线时,将 asset_url 用作输入值

支持的内容类型:image/(最大 10MB)、video/(最大 50MB)、audio/*(最大 20MB)

参数:

名称类型必填描述
content_typestring文件的 MIME 类型(例如 ‘image/jpeg’、‘image/png’、‘video/mp4’、‘audio/mpeg’)
filenamestring要上传的文件名(例如 ‘photo.jpg’、‘video.mp4’)


资源

billing://balance

积分余额

你当前的积分余额,包括可用积分和已预留积分。

MIME 类型: application/json


billing://history

积分历史

你的积分交易记录,展示购买、使用和退还情况。

MIME 类型: application/json


assets://list

列出素材

列出你生成的素材(图像、视频、音频)。来自流水线运行的所有素材。

MIME 类型: application/json


assets://get/{asset_id}

获取素材

按 ID 获取某个特定素材的详情,包括元数据和下载 URL。

MIME 类型: application/json


assets://list/{type}

按类型列出素材

列出你生成的素材,并按类型(image、video、audio)筛选。

MIME 类型: application/json



实时通知

当你运行一条流水线时,MCP 服务器会自动订阅状态更新。通知使用方法 notifications/pipeline/status

{
"method": "notifications/pipeline/status",
"params": {
"run_id": "uuid",
"status": "completed",
"pipeline_name": "Pipeline Name",
"pipeline_slug": "pipeline-slug",
"assets": [
{
"id": "uuid",
"url": "https://s3.pipe2.ai/assets/...",
"type": "image"
}
]
}
}

状态取值: pendingrunningcompletedfailedcancelled