使用说明

项目简介

AviUtl MCP服务器是一个基于 Model Context Protocol (MCP) 的应用后端,旨在通过标准化的 MCP 协议,使得 LLM 客户端能够控制和操作 AviUtl 视频编辑器。该项目包含一个 AviUtl 插件和一个 Python MCP 服务器,二者协同工作,允许用户通过 MCP 客户端(如 Claude Desktop)调用预设的工具来获取 AviUtl 项目的信息。

主要功能点

  • 工具 (Tools): 目前提供了一个工具 'get_project_info',用于获取当前 AviUtl 项目的宽度、高度、音频采样率、音频通道数和帧率等信息。未来可能扩展更多控制 AviUtl 编辑器的工具。
  • MCP服务器: 实现 MCP 服务器功能,接收来自 MCP 客户端的 JSON-RPC 请求,并返回符合 MCP 协议的响应。
  • AviUtl 插件: 作为 MCP 服务器的桥梁,与 AviUtl 软件进行交互,并将 AviUtl 的信息传递给 MCP 服务器。
  • 命名管道通信: 使用命名管道作为 AviUtl 插件和 Python MCP 服务器之间的通信方式,保证本地安全高效的数据传输。

安装步骤

  1. 下载仓库: 首先,从 GitHub 仓库 aviutl-mcp 下载项目代码。
  2. 复制插件: 将 'plugin/mcp.auf' 文件复制到 AviUtl 的 'plugins' 文件夹中。
  3. 安装 uv: 确保你的系统安装了 'uv'。你可以参考 uv 的官方文档进行安装。
  4. 安装 Python 依赖: 虽然仓库中没有明确的 requirements.txt,但根据代码,你需要安装 'pywin32'。可以使用 pip 安装:'pip install pywin32'。如果你使用 uv,可以使用 'uv pip install pywin32'。
  5. 配置 MCP 服务器: 根据你使用的 MCP 客户端(例如 Claude Desktop),配置 AviUtl MCP 服务器的启动命令。

服务器配置

以下是在 Claude Desktop 中配置 AviUtl MCP 服务器的示例配置信息。你需要将以下 JSON 代码添加到 Claude Desktop 的配置文件 'claude_desktop_config.json' 中。

{
    "mcpServers": {
        "aviutl_mcp": {
            "command": "uv",
            "args": [
                "--directory",
                "C:\\path\\to\\aviutl-mcp\\mcp_server",
                "run",
                "mcp",
                "run",
                "C:\\path\\to\\aviutl-mcp\\mcp_server\\main.py"
            ]
        }
    }
}

参数说明:

  • '"aviutl_mcp"': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器。
  • '"command": "uv"': 指定用于启动服务器的命令为 'uv',你需要确保 'uv' 命令在你的系统 PATH 环境变量中可用。
  • '"args"': 启动参数列表,包括:
    • '"--directory"': 指定 Python 脚本的运行目录为 'C:\path\to\aviutl-mcp\mcp_server',请将 'C:\path\to\aviutl-mcp' 替换为你实际的 'aviutl-mcp' 仓库的本地路径。
    • '"run"': 'uv' 命令的子命令,表示运行 Python 脚本。
    • '"mcp"': 可能是 'uv run' 命令的附加参数,具体作用需要参考 'uv' 的文档。
    • '"run"': 同上。
    • '"C:\path\to\aviutl-mcp\mcp_server\main.py"': 指定要运行的 Python 脚本的完整路径,同样需要替换为你的实际路径。

注意: 请务必根据你的实际 'aviutl-mcp' 仓库的存放路径,修改配置文件中的 'C:\path\to\aviutl-mcp' 部分。

基本使用方法

  1. 启动 AviUtl: 首先启动 AviUtl 软件,并确保 'mcp.auf' 插件已正确加载(通常在“滤镜”菜单中不会看到任何变化,插件在后台运行)。
  2. 配置 MCP 客户端: 打开你的 MCP 客户端 (如 Claude Desktop),并按照其说明配置连接到名为 'aviutl_mcp' 的 MCP 服务器。 Claude Desktop 的配置方法参考 "服务器配置" 章节。
  3. 使用工具: 在 MCP 客户端中,你应该能够发现 'aviutl_mcp' 服务器提供的工具,例如 'get_project_info'。你可以调用这个工具来获取当前 AviUtl 项目的信息。具体的调用方式取决于你使用的 MCP 客户端。

通过以上步骤,你就可以使用 AviUtl MCP 服务器,通过 MCP 客户端与 AviUtl 进行交互,并利用提供的工具获取项目信息。

信息

分类

桌面与硬件