Imagegen Mcp D3

内容 JavaScript

🚀 DALL-E 3 MCP Server

DALL-E 3 MCP Server 是一个模型上下文协议（MCP）服务器，它借助标准化的 MCP 接口，让大语言模型（LLMs）能够使用 OpenAI 的 DALL-E 3 模型生成高质量图像。

✨ 主要特性

🎨 高质量图像生成：采用 DALL-E 3 进行前沿的图像创作。
🔧 灵活配置：支持不同的尺寸、质量级别和风格。
📁 自动文件管理：处理目录创建和文件保存。
🛡️ 强大的错误处理：具备全面的错误处理和详细反馈。
📊 详细日志记录：为调试和监控提供全面的日志。
🚀 TypeScript 支持：全类型化，带来更好的开发体验。
🧪 充分测试：拥有高覆盖率的综合测试套件。

📦 安装指南

使用 NPX（推荐）

npx imagegen-mcp-d3

使用 NPM

npm install -g imagegen-mcp-d3

从源代码安装

git clone https://github.com/chrisurf/imagegen-mcp-d3.git
cd imagegen-mcp-d3
npm install
npm run build
npm start

前提条件

Node.js：版本 18.0.0 或更高。
OpenAI API 密钥：你需要一个有效的、具备 DALL-E 3 访问权限的 OpenAI API 密钥。

配置

环境变量

将你的 OpenAI API 密钥设置为环境变量：

export OPENAI_API_KEY="your-openai-api-key-here"

或者在项目根目录创建一个 .env 文件：

OPENAI_API_KEY=your-openai-api-key-here

💻 使用示例

与 Claude Desktop 配合使用

将此服务器添加到你的 Claude Desktop 配置中：

{
"mcpServers": {
"imagegen-mcp-d3": {
"command": "npx",
"args": ["imagegen-mcp-d3"],
"env": {
"OPENAI_API_KEY": "your-openai-api-key-here"
}
}
}
}

与其他 MCP 客户端配合使用

该服务器实现了标准的 MCP 协议，可与任何兼容的客户端配合使用。

可用工具

`generate_image`

使用 DALL-E 3 生成图像并保存到指定位置。

参数：

prompt（必需）：要生成图像的文本描述。
output_path（必需）：图像应保存的完整文件路径。
size（可选）：图像尺寸 - "1024x1024"、"1024x1792" 或 "1792x1024"（默认："1024x1024"）。
quality（可选）：图像质量 - "standard" 或 "hd"（默认："hd"）。
style（可选）：图像风格 - "vivid" 或 "natural"（默认："vivid"）。

示例：

{
"name": "generate_image",
"arguments": {
"prompt": "A serene sunset over a mountain lake with pine trees",
"output_path": "/Users/username/Pictures/sunset_lake.png",
"size": "1024x1792",
"quality": "hd",
"style": "natural"
}
}

响应：该工具返回有关生成图像的详细信息，包括：

原始和修订后的提示。
图像 URL。
文件保存位置。
图像规格。
文件大小。

📚 详细文档

API 参考

图像尺寸

方形：1024x1024 - 非常适合社交媒体和一般用途。
竖版：1024x1792 - 适合手机壁纸和垂直显示屏。
横版：1792x1024 - 适合桌面壁纸和水平显示屏。

质量选项

标准：生成速度更快，质量良好。
高清：更高质量，细节更丰富（推荐）。

风格选项

鲜艳：更具戏剧性和艺术感的诠释。
自然：更逼真、自然的效果。

开发

环境搭建

git clone https://github.com/chrisurf/imagegen-mcp-d3.git
cd imagegen-mcp-d3
npm install

可用脚本

npm run dev          # 在开发模式下运行，支持热重载
npm run build        # 为生产环境构建
npm run start        # 启动构建后的服务器
npm run test         # 运行测试
npm run test:watch   # 在监视模式下运行测试
npm run test:coverage # 运行测试并生成覆盖率报告
npm run lint         # 运行 ESLint
npm run lint:fix     # 修复 ESLint 问题
npm run format       # 使用 Prettier 格式化代码
npm run typecheck    # 运行 TypeScript 类型检查

项目结构

src/
├── index.ts           # 主服务器实现
├── types.ts          # TypeScript 类型定义
└── __tests__/        # 测试文件
└── index.test.ts # 主测试套件

运行测试

# 运行所有测试
npm test

# 运行测试并生成覆盖率报告
npm run test:coverage

# 在开发期间以监视模式运行测试
npm run test:watch

错误处理

服务器针对常见场景提供了全面的错误处理：

缺少 API 密钥：当未设置 OPENAI_API_KEY 时，显示清晰的错误消息。
参数无效：对必需和可选参数进行验证错误处理。
API 错误：显示来自 OpenAI API 的详细错误消息。
文件系统错误：处理目录创建和文件写入问题。
网络错误：优雅处理网络连接问题。

日志记录

服务器为监控和调试提供详细的日志记录：

请求发起和参数。
API 通信状态。
图像生成进度。
文件保存确认。
错误详情和堆栈跟踪。

🤝 贡献

我们欢迎贡献！请参阅我们的贡献指南了解详细信息。

开发工作流程

分叉仓库。
创建功能分支：git checkout -b feature/amazing-feature。
进行更改。
为新功能添加测试。
确保所有测试通过：npm test。
提交更改：git commit -m 'Add amazing feature'。
推送到分支：git push origin feature/amazing-feature。
打开拉取请求。

CI/CD

本项目使用 GitHub Actions 进行持续集成和部署：

测试：在多个 Node.js 版本（18、20、22）上进行自动化测试。
代码质量：进行 ESLint、Prettier 和 TypeScript 检查。
安全：进行依赖漏洞扫描。
发布：在发布时自动进行 NPM 发布。
覆盖率：本地代码覆盖率报告。

📄 许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。

支持

问题反馈：GitHub Issues
讨论交流：GitHub Discussions
邮件支持：通过提交问题获取支持。

更新日志

请参阅 CHANGELOG.md 了解详细的更改历史。

致谢

感谢 OpenAI 提供 DALL-E 3 API。
感谢 Anthropic 提供模型上下文协议规范。
感谢 MCP 社区提供的工具和文档。

高性能 MCP 用于使用 DALL·E 3 生成图像 - 针对快速、可扩展和可定制的推理工作流程进行了优化。

0 条评论
分类：内容