使用说明
-
项目简介
- VectCutAPI 中的 mcp_server.py 实现了一个基于 MCP 协议的服务器,能够接收 MCP 客户端的请求(如读取资源、执行工具、获取草稿等),并返回标准的 JSON-RPC 响应。服务器核心围绕草稿创建、素材添加与变换、以及草稿的保存/导出等能力构建,适合用作将 CapCut 风格的编辑能力暴露给 LLM 客户端的后端服务。
- 服务器通过标准的 JSON-RPC 进行请求/响应,包含 initialize、tools/list、tools/call、query_script、save_draft、add_video、add_audio、add_image、add_text、add_subtitle、add_effect、add_sticker、add_video_keyframe、get_video_duration 等核心方法。
-
主要功能点
- MCP 协议核心功能
- initialize:初始化并声明客户端能力
- tools/list:返回可用工具列表
- tools/call:按名称调用工具(如 create_draft、add_text、add_video 等)
- query_script / save_draft / query_draft_status:管理草稿和查看进度
- 多种媒体操作接口:add_video、add_audio、add_image、add_text、add_subtitle、add_sticker
- 进阶操作:add_video_keyframe、get_video_duration、add_effect
- 资源与工具托管
- 通过 CapCut/Jianying 风格的实现,暴露素材、工具的执行能力,以及草稿的导出/上传等处理流程
- 服务器与客户端解耦
- 客户端通过 JSON-RPC 调用服务器端的工具,服务器端根据传入参数执行对应的 CapCut 编辑动作并返回结果
- 简易的容器化/配置友好
- 通过 mcp_config.json 等配置项,可把 MCP 服务与客户端的连接信息解耦
- MCP 协议核心功能
-
安装步骤
- 将仓库克隆到本地
- 确认 Python3.10+ 环境
- 安装依赖(如 requirements.txt 及相关 MCP 依赖,可按 README 提示进行)
- 根据需要修改配置文件 config.json(如服务器端口、路径等)
- 启动 MCP 服务端:运行 mcp_server.py(默认通过 STDIN/STDOUT 与 MCP 客户端通信)
-
服务器配置(MCP 客户端需要的配置信息) 说明:MCP 客户端需要的仅是启动服务器所需信息,配置文件用于 MCP 客户端知道如何启动服务器进程以及传入参数。下面给出一个符合实际仓库信息的示例,包含 server name、command、args、cwd 与环境变量等字段说明。请按实际部署路径填写。
- server_name: vectcut-capcut-mcp
- command: python
- args: ["mcp_server.py"]
- cwd: 运行目录的绝对路径,例如 "/path/to/VectCutAPI"
- env: { "PYTHONPATH": "/path/to/VectCutAPI", "DEBUG": "0" }
-
基本使用方法
- 启动 MCP 服务器后,MCP 客户端通过标准 JSON-RPC 请求与之通信,常用流程包括:
- 发送 initialize 请求,声明协议版本和能力
- 请求 tools/list 获取可用工具
- 通过 tools/call 调用具体工具(如 create_draft、add_text、save_draft 等),传入所需参数
- 使用 query_script / save_draft / query_draft_status 获取草稿与任务状态
- 结合示例客户端(如 test_mcp_client.py)可进行端到端的功能验证。
- 启动 MCP 服务器后,MCP 客户端通过标准 JSON-RPC 请求与之通信,常用流程包括:
-
简要注意事项
- MCP 服务端实现以 STDIO 形式工作,需确保客户端与服务器之间的换行符和编码一致性。
- 服务器对调用参数进行了较多的边界检查,实际使用时请确保传入的参数类型与字段名符合服务器端实现的要求。
信息
分类
网页与API