使用说明

项目简介

MAVAE 图像工具箱 (MAVAE - IMAGE TOOLBOX) 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 AI 智能体提供标准化的图像媒体工具接口。它允许 AI 智能体通过 MCP 协议调用各种图像生成和编辑功能,从而扩展其在图像处理方面的能力。

主要功能点

  • 图像生成: 支持使用原始配置或预定义集合生成图像。
  • 图像编辑: 提供图像压缩和裁剪功能。
  • 集合管理: 允许创建、管理和共享图像生成配置,方便用户进行一致性的图像生成。
  • 模型与 Lora 管理: 可以列出并使用可用的模型和 LoRA。
  • API 令牌管理: 处理 API 令牌认证,确保服务交互的安全性。

安装步骤

  1. 安装 Node.js: 确保你的系统已安装 Node.js (v16 或更高版本)。
  2. 安装依赖: 在仓库根目录下运行 'npm install' 命令安装项目依赖。
  3. 构建项目: 运行 'npm run build' 命令编译 TypeScript 代码。
  4. 启动服务器: 运行 'npm start' 命令启动 MCP 服务器。启动前请确保已设置环境变量 'MAVAE_API_KEY',你可以前往 MAVAE 申请页面 申请 API Key。

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 MAVAE MCP 服务器。请注意替换 '***/dist/index.js' 为服务器 'dist/index.js' 文件的实际绝对路径。

{
  "mcpServers": {
      "mavae": {
          "command": "node",
          "args": [
              "***/dist/index.js"  //  请替换为服务器 dist/index.js 文件的实际绝对路径
          ],
          "env": {
              "MAVAE_API_KEY": "<你的 MAVAE API KEY>" //  请替换为你申请的 MAVAE API KEY
          }
      }
  }
}

基本使用方法

MAVAE MCP 服务器启动后,MCP 客户端可以通过 JSON-RPC 协议与之通信。客户端可以发送请求调用服务器提供的各种工具,例如:

  • 调用 'image_raw_generate' 工具生成图像。
  • 调用 'compress_image' 工具压缩图像。
  • 调用 'collection_create' 工具创建图像集合。

具体的工具列表和参数定义请参考仓库 'README.md' 文档中 "Available Tools" 章节。客户端需要根据 MCP 协议规范构造 JSON-RPC 请求,并发送到 MAVAE MCP 服务器。服务器会处理请求并返回 JSON-RPC 响应。

信息

分类

AI与计算