概览/MCP/快速开始

快速开始

先拿 API Key,再接好一个 MCP client,并跑通第一次创建。

快速开始

这一页给你一套最小 MCP 配置,让 KPainter 能先在一个兼容的 MCP client 里跑起来。

第 1 步:获取 API Key

KPainter MCP 使用用户自己的 API Key。

在配置 client 之前,先完成:

  1. 注册或登录 KPainter
  2. 打开 API Key 页面
  3. 激活并复制你的 API Key
  4. 把这把 key 准备给 MCP client 配置

第 2 步:先接一个本地 stdio MCP Server

对本地 MCP client 来说,stdio 是最容易起步的方式。

如果你的环境里已经能直接运行 kp-mcp,标准配置可以写成:

{  "mcpServers": {    "kpainter": {      "command": "kp-mcp",      "env": {        "KGP_API_KEY": "<your_api_key>"      }    }  }}

如果你是从 kgp-service 源码目录启动,也可以写成:

{  "mcpServers": {    "kpainter": {      "command": "python",      "args": ["-m", "src.mcp_server"],      "cwd": "/path/to/kgp-service",      "env": {        "KGP_API_KEY": "<your_api_key>"      }    }  }}

第 3 步:先校验 Key

当前 CLI 启动命令使用 kp-mcp

MCP 工具名现在统一使用 kp_* 前缀,所以调用时请使用 kp_mekp_get_catalog 这一套名字。

MCP server 连上后,先从这个工具开始:

  • kp_me

先确认:

  • key 有效
  • 解析到的是预期用户
  • 当前 key 具备创作能力

不要一上来就跳过这步直接创建。

第 4 步:读取 Catalog

接下来调:

  • kp_get_catalog

在决定这些参数之前,都先看 catalog:

  • type
  • aspect_ratio
  • output_quality
  • voice_id
  • style_id
  • duration_seconds
  • scene_count

不要自己猜。

第 5 步:发起第一次创建

第一条 happy path 一般是:

  1. kp_me
  2. kp_get_catalog
  3. kp_create_creation
  4. kp_get_job_status
  5. kp_get_creation

例如你可以让 MCP client 帮你创建:

做一个英文图解版知识视频,用 6 个场景讲清楚 MCP 是怎么工作的。

随后 client 应根据 kp_get_catalog 返回的正式类型和参数范围,把它映射成真实可用的创建请求。

第 6 步:读取最终结果

任务成功后,从 kp_get_creation 里重点读取:

  • main_url
  • artifacts
  • scenes
  • editable_actions

这里才是成品详情的主读取面。

如果还要改单场景

对支持的类型,先看 editable_actionsscenes,再调用:

  • kp_edit_scene

当前单场景编辑动作包括:

  • update_scene_narration
  • regenerate_scene

编辑也要按异步链路处理:

  1. kp_edit_scene
  2. kp_get_job_status
  3. kp_get_creation

接下来读什么

  • 身份认证
    api_key 和默认 key 回退怎么工作
  • 传输方式
    看什么时候用 stdio,什么时候用 Streamable HTTP
  • 可用工具
    查看当前 tools、resources 和 prompts