使用说明

项目简介

本项目 'mcp_generate_images' 是一个 MCP (Model Context Protocol) 服务器的实现,专注于提供 AI 图像生成服务。它基于 Together AI 的 API,允许用户通过文本提示,利用 Cursor IDE 或其他兼容 MCP 协议的客户端调用,快速生成高质量的图像。此服务旨在简化 LLM 应用与图像生成工具的集成,提供标准化的接口和便捷的使用体验。

主要功能点

  • 文本到图像生成: 根据用户提供的文本提示,生成符合描述的图像。
  • 可配置图像参数: 支持自定义生成图像的宽度、高度和生成步数等参数。
  • 灵活的保存选项: 允许用户指定图像的保存路径和文件名,并支持多种图片格式(png, jpg, jpeg)。
  • 错误处理和重试机制: 具备自动重试和错误处理机制,确保图像生成服务的稳定性。
  • 批量生成: 支持批量生成多张图片,提高效率。
  • 路径和权限验证: 在保存图片时进行路径有效性和权限验证,保障安全性。
  • 异步处理: 采用异步处理方式,提升服务响应速度。

安装步骤

  1. 环境准备:

    • 确保已安装 Python 3.10+Node.js 环境。推荐使用 'pyenv' 管理 Python 版本。
    • 安装快速的 Python 包管理器 uv。 可以使用 'brew install uv' (macOS) 或 'pip install uv'。
    • 注册并获取 Together AI API 密钥。访问 Together AI API Keys 获取。
    • 推荐使用 Cursor IDE 以获得最佳集成体验,但理论上任何兼容 MCP 协议的客户端均可。
  2. 克隆项目: 使用 'git clone https://github.com/chenyeju295/mcp_generate_images.git' 命令克隆仓库到本地。

  3. 安装依赖: 进入项目目录 'mcp_generate_images',运行命令 'python3 -m pip install fastmcp requests' 安装必要的 Python 依赖库。 如果遇到网络问题,可以尝试使用提供的备用命令。

  4. 配置 API 密钥: 编辑 'mcp_server.py' 文件,将 'TOGETHER_API_KEY = "your_api_key_here"' 替换为你自己的 Together AI API 密钥。

  5. 配置服务参数 (可选): 在 'mcp_server.py' 文件中,可以根据需要修改 'CONFIG' 字典中的配置,例如:

    • 'api.model': 选择不同的图像生成模型。
    • 'image.default_width', 'image.default_height': 设置默认图片尺寸。
    • 'output.base_folder': 设置默认图片保存路径。 请务必使用绝对路径

服务器配置

为了让 MCP 客户端(如 Cursor IDE)连接到此图像生成 MCP 服务器,你需要提供以下配置信息。这是一个 JSON 格式的配置,通常在 MCP 客户端的设置中添加。

{
  "serverName": "image_generation_mcp_server",
  "command": "uv run --with fastmcp fastmcp",
  "args": [
    "run",
    "<path_to_mcp_server.py>"  // 将 '<path_to_mcp_server.py>' 替换为 mcp_server.py 文件的**绝对路径**,例如:"/Users/username/Documents/mcp_generate_images/mcp_server.py"
  ],
  "description": "AI 图像生成 MCP 服务",
  "languages": ["*"],
  "documentSelectors": ["*"],
  "同步": false
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义,用于在客户端中标识该服务。 例如: '"image_generation_mcp_server"'。
  • 'command': 启动 MCP 服务器的命令。 固定为 '"uv run --with fastmcp fastmcp"', 表示使用 'uv' 运行器,并加载 'fastmcp' 模块来启动 MCP 服务。
  • 'args': 传递给 'command' 的参数列表。
    • '"run"': 'fastmcp' 的子命令,表示以运行模式启动服务器。
    • '"<path_to_mcp_server.py>"': 必须替换为 'mcp_server.py' 文件的绝对路径。这是服务器脚本的实际位置。 例如,如果你的 'mcp_server.py' 文件在 '/Users/myuser/mcp_generate_images/mcp_server.py',则应替换为 '"/Users/myuser/mcp_generate_images/mcp_server.py"'。
  • 'description': 对该 MCP 服务器的简短描述,用于在客户端界面显示。 例如: '"AI 图像生成 MCP 服务"'。
  • 'languages': 指定该 MCP 服务器适用的编程语言。 '"["*"]"' 表示适用于所有语言。
  • 'documentSelectors': 指定该 MCP 服务器适用的文档类型。 '"["*"]"' 表示适用于所有文档。
  • '同步': 布尔值,指定 MCP 服务器是否以同步模式运行。 'false' 表示异步模式,通常用于提高性能。

重要提示: 请务必将 '<path_to_mcp_server.py>' 替换为 'mcp_server.py' 文件的绝对路径。 错误的路径会导致 MCP 客户端无法连接到服务器。

基本使用方法

  1. 启动 MCP 服务器: 根据 "服务器配置" 中的 'command' 和 'args',在终端中运行相应的命令来启动 MCP 服务器。 例如,在项目根目录下运行:

    uv run --with fastmcp fastmcp run /Users/username/Documents/mcp_generate_images/mcp_server.py

    或者使用开发模式(带调试界面):

    uv run --with fastmcp fastmcp dev /Users/username/Documents/mcp_generate_images/mcp_server.py

    请确保服务器成功启动,没有报错信息。

  2. 在 MCP 客户端中使用 (以 Cursor IDE 为例):

    • 打开 Cursor IDE,进入设置或扩展配置界面 (通常在设置中搜索 "mcp" 或 "Model Context Protocol")。
    • 添加新的 MCP 服务器配置,将上面提供的 JSON 配置信息粘贴到客户端的配置中。
    • 确保配置中的 '<path_to_mcp_server.py>' 已被替换为正确的绝对路径。
    • 保存配置后,客户端应该能够检测到并连接到你的 MCP 服务器。
  3. 调用图像生成工具:

    • 在 Cursor IDE 的编辑器中,可以使用 Agent (@) 模式或者其他与 MCP 服务器交互的方式,输入提示词来调用 'generate_image' 工具。
    • 例如,在 Cursor 的 Agent 输入框中,可以输入类似 '@generate_image prompt="生成一只可爱的猫" file_name="cat.png" save_folder="/Users/username/Documents/images"' 的命令。
    • MCP 服务器会接收到请求,调用 Together AI API 生成图像,并将图像保存到指定的路径。
    • 生成结果(图片保存路径等信息)将会返回给 MCP 客户端。

请参考 Cursor IDE 或你使用的 MCP 客户端的文档,了解更详细的 MCP 服务集成和使用方法。

信息

分类

AI与计算