Files

5.6 KiB
Raw Permalink Blame History

MCP 工具响应字段速查

完整协议与示例见同目录 api-examples.md。CLI 返回 { ok, status, body }body 为工具结果(已自动解析 JSON 文本块)。

响应字段统一 camelCase(服务端契约);旧版服务端可能仍返回 snake_case 同义字段(如 generation_idCLI 两种都能解析Agent 读取输出时按同一字段理解。

kling <command> --help 对 MCP-backed 命令会尽量展示该工具的实时 tools/list 声明(工具说明 + inputSchema获取失败时回退本地静态用法。完整模型清单与参数规格见下方 who_am_i

who_am_i能力发现

  • user.userId:当前用户 ID来自 JWT
  • availableModels:工具名 → 模型能力清单;空 {} 表示服务端尚未配置。
    • [].model:模型名(生成命令 --model 的合法取值)。
    • [].alias:对外别名(可能不出现)。
    • [].description:模型说明,Agent 选型的主要依据(适用场景、是否推荐等;可能不出现)。
    • [].arguments[]{ name, required, default?, allowedValues?, description? }
    • [].inputs[]{ name, required, description? }(参考资源声明)。
  • authMode鉴权模式OAuth 登录态下为 oauth)。

异步生成工具提交成功后text_to_image / image_to_image / text_to_video / image_to_video / motion_control

主体库(element_*为同步操作响应见下方「主体库Element 工具)」;创建主体返回持久主体 id,不使用 generationIdquery_tasks 轮询。

  • generationId:不透明生成 ID用于 query_tasks 轮询。
  • status:初始状态(下游透传,如 submitted / QUEUING)。
  • creditsConsumed:本次消耗的灵感值(可能不出现)。

query_tasks

  • generationId:回显查询 ID。
  • status:任务整体状态(下游透传字符串,大小写不敏感处理
    • 中间态:QUEUING / RUNNING / submitted / processing
    • 成功终态:COMPLETED / PARTIAL_COMPLETED / succeed
    • 失败终态:FAILED / CANCELLED
  • createTime / finishTime:毫秒时间戳(未完成时 finishTime 为 0
  • works[]:产出列表:
    • status:单个产出状态。
    • contentTypeimage / video
    • url:资源 URL带水印默认展示
    • urlWithoutWatermark:无水印资源 URL用户要求时展示
    • coverUrl / coverUrlWithoutWatermark:封面 URL。

file_upload两步式

  • 第一步MCP 工具)返回:ticket(一次性票据)、uploadUrl(上传地址)、expireAt(过期时间戳)。
  • 第二步由 CLI 自动完成multipart POSTticket + file)到 uploadUrlCLI 会把响应中的文件 URL 规整到 body.url

主体库Element 工具)

  • element_create:返回持久 Element id;图片资源为 cover + 13 个 secondary[],视频资源为 video,两者可选 voice
  • element_list:每项仅含 id / name;完整类型与资源需再调 element_get
  • element_get:返回完整 name / description / resource / tags
  • element_updateCLI 先读取现有 Element再把用户提供的可选字段合并成完整 payload图片 Element 强制回填原 resource.cover,不接受 --cover
  • element_delete:按 id 删除持久 Element。

motion_library_list / motion_control

  • motion_library_list:每项含 idname、动作 URL、可选封面、毫秒时长和是否含音频。
  • motion_control:返回与其他生成工具相同的 generationId / status / creditsConsumed,后续用 query_tasks

feedback

  • 返回服务端确认信息;该工具只记录反馈,不会重试、退款或修复原任务。
  • 请求的 extra 可携带关联的 generationId[] / modelVersion[] / taskTraceId[],分别来自可重复的 --generationId / --modelVersion / --relatedTaskTraceId;不假定服务端响应会回显这些字段。

logout

  • 先调用服务端 MCP logout;成功后清除本地登录态。服务端失败时保留本地登录态并返回错误,不继续登录。

accountquery_membership_and_credits 直通)

  • userId:用户 ID。
  • membershipType:会员身份(NORMAL / VIP / SVIP / SSVIP / SSSVIP)。
  • availableRemainCredits:可用灵感值(用户可见值,无需换算)。0 或过低时,按「余额不足与充值」引导用户充值。
  • 充值 / 会员链接:不在响应 body 里,而在该工具的 descriptiontools/list 元数据) 中由服务端动态提供。需要引导充值时取用该链接,勿在本地写死(详见 SKILL「余额不足与充值」

tool_listMCP tools/list

  • body.tools[]:后端 MCP server 当前暴露的工具清单。
  • name工具名CLI 的 canonical 业务命令通常与后端 MCP 工具名 1:1。
  • description:服务端提供的工具说明;商业化链接等动态说明以这里为准,勿在本地写死。
  • inputSchema:该工具的 JSON Schema 输入声明,用于排障或确认服务端实际支持的参数。

CLI 轮询结果(--poll / query_tasks --poll

  • body.polledtrue 表示这是轮询聚合结果。
  • body.timedOut:是否超时(超时后可继续 query_tasks <generationId>)。
  • body.generations[]{ generationId, status, result }result 即最后一次 query_tasks 的返回体。