使用说明
项目简介
本项目 'DALL-E MCP Server' 是一个实现了 Model Context Protocol (MCP) 的服务器,专门用于通过 OpenAI 的 DALL-E API 生成图像。它允许 MCP 客户端(如 Cline)调用工具来生成、编辑和创建 DALL-E 图像变体。
主要功能点
- 文生图 (generate_image): 根据文本提示,使用 DALL-E 2 或 DALL-E 3 模型生成图像。支持选择模型版本、图像尺寸、图片质量和风格(DALL-E 3)、生成数量等参数。
- 图像编辑 (edit_image): 基于文本提示和提供的原始图像,使用 DALL-E 2 模型编辑现有图像。可以指定编辑区域的掩码。
- 图像变体生成 (create_variation): 基于提供的原始图像,使用 DALL-E 2 模型生成图像的变体。
- API Key 验证 (validate_key): 验证配置的 OpenAI API Key 是否有效。
安装步骤
-
克隆仓库:
git clone https://github.com/Garoth/dalle-mcp.git cd dalle-mcp -
安装依赖:
npm install -
构建项目:
npm run build
服务器配置
要将 'DALL-E MCP Server' 集成到 MCP 客户端(例如 Cline),您需要配置客户端的 MCP 设置。以下是 Cline 的配置示例,您需要根据您的 MCP 客户端进行调整。
在 Cline 的 MCP 设置文件 ('cline_mcp_settings.json') 中,添加如下配置项:
{ "mcpServers": { "dalle-mcp": { "command": "node", "args": ["/path/to/dalle-mcp-server/build/index.js"], "env": { "OPENAI_API_KEY": "your-api-key-here", "SAVE_DIR": "/path/to/save/directory" }, "disabled": false, "autoApprove": [] } } }
配置参数说明:
- '"dalle-mcp"': 服务器名称,您可以自定义。
- '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行时。
- '"args": ["/path/to/dalle-mcp-server/build/index.js"]': 启动命令的参数,指向构建后的 'index.js' 文件路径。 请将 '/path/to/dalle-mcp-server/build/index.js' 替换为实际的 'dalle-mcp' 服务器构建目录下的 'index.js' 文件的绝对路径。
- '"env"': 环境变量配置。
- '"OPENAI_API_KEY": "your-api-key-here"': 请将 '"your-api-key-here"' 替换为您的 OpenAI API Key。 您可以在 OpenAI API Keys 页面 获取。
- '"SAVE_DIR": "/path/to/save/directory"': 可选配置。请将 '/path/to/save/directory' 替换为您希望保存生成图像的目录的绝对路径。 如果不配置,默认保存到服务器运行目录。 对于 Cline 用户,建议设置为您当前工作区目录的路径,以便 Cline 能够正确显示生成的图像。
- '"disabled": false': 设置为 'false' 启用该服务器。
- '"autoApprove": []': 自动批准的工具列表,默认为空。
确保替换配置中的路径和 API Key 为您实际的值。
基本使用方法
配置完成后,在 MCP 客户端中,您可以使用以下工具与 'DALL-E MCP Server' 交互:
-
generate_image (文生图): 调用 'generate_image' 工具,并提供 'prompt' 参数来描述您想要生成的图像。例如:
{ "tool_call": { "name": "generate_image", "arguments": { "prompt": "A futuristic city with flying cars and neon lights", "model": "dall-e-3", "size": "1024x1024" } } } -
edit_image (图像编辑): 调用 'edit_image' 工具,需要提供 'prompt' (编辑描述) 和 'imagePath' (原始图像路径) 参数。 可以选择性提供 'mask' 参数(掩码图像路径)。 例如:
{ "tool_call": { "name": "edit_image", "arguments": { "prompt": "Add a red hat", "imagePath": "/path/to/image.png" } } } -
create_variation (图像变体生成): 调用 'create_variation' 工具,需要提供 'imagePath' (原始图像路径) 参数。例如:
{ "tool_call": { "name": "create_variation", "arguments": { "imagePath": "/path/to/image.png" } } } -
validate_key (API Key 验证): 调用 'validate_key' 工具,无需参数,用于验证 API Key 是否有效。
{ "tool_call": { "name": "validate_key", "arguments": {} } }
请注意:
- 图像文件路径 ('imagePath', 'mask') 可以是相对路径或绝对路径。相对路径是相对于服务器运行目录。
- 生成的图像会保存在配置的 'SAVE_DIR' 目录下,或者默认的服务器运行目录下。
- 详细的工具参数说明请参考仓库的 'README.md' 文件。
信息
分类
AI与计算