使用说明

项目简介

Recraft MCP 服务器是一个实现了 Model Context Protocol (MCP) 协议的服务器端应用。它集成了 Recraft.ai 强大的图像生成和处理 API,通过标准化的 MCP 接口,使得支持 MCP 协议的 LLM 客户端能够轻松调用 Recraft 的各种图像工具,例如根据文本生成图像、编辑现有图像、进行风格迁移、背景替换、图像矢量化和放大等。本服务器旨在为 LLM 应用提供一个安全、可扩展的方式来利用 Recraft.ai 的图像能力。

主要功能点

  • 图像生成: 根据文本提示词生成高质量图像。
  • 图像编辑: 支持图像到图像的转换、局部图像修复 (inpaint)、背景替换等多种编辑功能。
  • 图像增强: 提供图像锐化放大 (crisp upscale) 和创意放大 (creative upscale) 功能,提升图像质量。
  • 图像矢量化: 将位图图像转换为矢量 SVG 格式。
  • 用户信息: 获取 Recraft.ai 用户账户信息,如可用额度。
  • 本地保存: 支持将生成的图像保存到服务器本地文件系统。
  • 标准化接口: 遵循 MCP 协议,易于集成到任何支持 MCP 协议的 LLM 客户端。
  • 参数校验: 使用 Zod 进行严格的参数校验,确保请求的有效性。

安装步骤

  1. 克隆仓库

    git clone https://github.com/BartWaardenburg/recraft-mcp-server.git
    cd recraft-mcp-server
  2. 安装依赖

    npm install
  3. 配置 Recraft API 密钥

    复制 '.env.example' 文件并重命名为 '.env',然后编辑 '.env' 文件,填入您的 Recraft API 密钥。您需要在 recraft.ai 注册并获取 API 密钥。

    cp .env.example .env

    编辑 '.env' 文件,添加您的 API 密钥:

    RECRAFT_API_KEY=YOUR_RECRAFT_API_KEY

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接 Recraft MCP 服务器。客户端需要配置 'command' 和 'args' 来启动服务器进程。

{
  "server name": "recraft-mcp-server",
  "command": "npm",
  "args": [
    "start"
  ],
  "description": "Recraft MCP Server",
  "transport": "stdio"
}

配置参数说明:

  • 'server name': 服务器的名称,可以自定义,用于在 MCP 客户端中标识该服务器。
  • 'command': 启动服务器的命令,这里使用 'npm',表示使用 npm 运行脚本。
  • 'args': 传递给 'command' 的参数,'["start"]' 表示运行 'npm start' 命令,这会根据 'package.json' 中的配置启动服务器。
  • 'description': 服务器的描述信息,方便用户理解服务器的用途。
  • 'transport': 服务器使用的传输协议,'stdio' 表示标准输入输出流,这是本项目默认的传输方式。

基本使用方法

  1. 构建服务器

    npm run build
  2. 启动服务器

    npm start

    或者使用提供的 shell 脚本:

    ./start-mcp.sh

    服务器启动后,会监听标准输入输出流 (stdio) 等待 MCP 客户端的请求。

  3. 使用 MCP 客户端连接

    配置您的 MCP 客户端,使其连接到该服务器。客户端需要配置服务器的启动命令 (如上文 服务器配置 所示) 和服务器提供的工具定义。

  4. 调用 Recraft 工具

    通过 MCP 客户端,您可以调用服务器提供的各种 Recraft 工具,例如 'generate_image' (图像生成)、 'image_to_image' (图像转换) 等,并传递相应的参数。服务器会处理请求,调用 Recraft API,并将结果返回给客户端。

    例如,使用 'generate_image' 工具生成图像,客户端需要发送符合 MCP 协议的 JSON-RPC 请求,包含工具名称 'generate_image' 和相应的参数,例如 'prompt' (文本提示词)。

    具体工具的参数和使用方法,请参考仓库 'README.md' 或使用 MCP inspector 工具进行检查。

信息

分类

AI与计算