使用说明
OpenAI Image 1 Ideogram MCP
概述
OpenAI Image 1 Ideogram MCP 是一个企业级模型上下文协议(MCP)服务器,提供与Ideogram的v3.0 API的无缝集成。这种专业级的解决方案能够实现先进的AI图像生成功能,具有复杂的样式控制、渲染优化和生产环境的高质量输出。
此MCP服务器基于TypeScript和现代开发实践构建,为需要可靠AI图像生成服务的组织提供了强大的错误处理、全面的验证和企业级功能。
模型上下文协议(MCP)集成
此服务器实现 模型上下文协议(MCP) 标准,实现与人工智能助手和应用程序的无缝集成。MCP为AI模型访问外部工具和服务提供了一种标准化的方式,使Ideogram集成立即与以下内容兼容:
- 克劳德桌面:通过MCP配置直接集成
- 自定义AI应用程序:任何兼容MCP的客户端
- 开发环境:本地和基于云的AI开发设置
- 企业人工智能平台:跨组织的可扩展部署
MCP体系结构确保了人工智能模型和Ideogram v3.0 API之间的安全、可靠和标准化通信,提供了具有专业监督和控制的企业级图像生成功能。
📚 完整的文档套件
该存储库包括用于设置AI驱动的开发环境的全面文档:
快速链接
- Ideogram MCP服务器安装 -此MCP服务器设置指南
- 代理零安装 -基于Docker的人工智能开发平台
- 光标IDE设置 -AI驱动的代码编辑器
- Windsurf IDE安装 -第一个代理IDE
- Claude桌面设置 -MCP集成指南
- 增强代码平台 -高级AI编码助手
- MCP配置指南 -模型上下文协议设置
- API密钥管理 -安全身份验证设置
- 故障排除指南 -常见问题和解决方案
核心功能
高级图像生成
- Ideogram v3.0集成:完全支持具有增强功能的最新Ideogram API
- 风格参考系统:最多上传3个参考图像或使用8个字符的十六进制样式代码
- 渲染优化:可配置的渲染速度(TURBO、DEFAULT、QUALITY)用于性能调优
- 增强现实主义:以卓越的质量生成最先进的照片级真实感图像
- 专业图形:企业级文本渲染和创意设计能力
- 魔法提示增强:人工智能驱动的快速优化,以改善结果
生产准备能力
- 批处理:每个请求生成1-8张图像,以实现高效的工作流程
- 灵活的纵横比:支持15种标准宽高比,包括1x1、16x9、4x3等
- 分辨率控制:可访问69+分辨率选项,满足不同的输出要求
- 式管理:先进的风格编码系统,可访问43亿种预设风格
- 内容过滤:对精确内容排除的负面提示支持
- 可复制的一代:基于种子的控制,实现一致和可重复的结果
安装和设置
先决条件
- Node.js:18.0.0或更高版本
- npm:最新稳定版本
- Ideogram API密钥:从获取 Ideogram API管理
软件包安装
通过npm安装包:
npm install @lyoncrypt/openai-image-1-ideogram-mcp
Claude桌面集成
通过在配置文件中添加以下内容来配置Claude Desktop MCP设置:
{
"mcpServers": {
"openai-image-1-ideogram": {
"command": "npx",
"args": [
"@lyoncrypt/openai-image-1-ideogram-mcp"
],
"env": {
"IDEOGRAM_API_KEY": "your_ideogram_api_key_here"
}
}
}
}
环境配置
设置环境变量:
# Required: Ideogram API Key
export IDEOGRAM_API_KEY="your_ideogram_api_key"
# Optional: Custom output directory
export OUTPUT_DIR="./generated-images"
# Optional: Default filename prefix
export BASE_FILENAME="ai-generated-image"
api参考
generate_image
使用Ideogram的v3.0 API生成高质量图像的主要工具,具有全面的参数控制。
方法签名
generate_image(parameters: GenerateImageParams): Promise<GenerationResult>
参数
| 参数 | 类型 | 说明 | 必填 | 默认 |
|---|---|---|---|---|
prompt |
string |
主图像生成提示(推荐英文) | ✅ | - |
aspect_ratio |
AspectRatio |
支持选项中的图像宽高比 | ❌ | 1x1 |
resolution |
string |
具体决议(见支持的决议) | ❌ | 汽车 |
seed |
integer |
可重复结果的确定性种子(0-2147483647) | ❌ | 随机 |
magic_prompt |
MagicPrompt |
AI提示增强: AUTO |
ON |
OFF |
rendering_speed |
RenderingSpeed |
质量与速度: TURBO |
DEFAULT |
QUALITY |
style_codes |
string[] |
8个字符的十六进制样式代码数组 | ❌ | [] |
style_type |
StyleType |
样式类别: AUTO |
GENERAL |
REALISTIC |
style_reference |
StyleReference |
高级样式参考配置 | ❌ | null |
negative_prompt |
string |
内容排除规范 | ❌ | "" |
num_images |
integer |
发电批量(1-8) | ❌ | 1 |
output_dir |
string |
本地存储目录路径 | ❌ | "docs" |
base_filename |
string |
文件命名前缀 | ❌ | "ideogram-image" |
blur_mask |
boolean |
应用艺术边缘模糊效果 | ❌ | false |
样式参考对象
{
urls?: string[]; // Up to 3 reference image URLs
style_code?: string; // 8-character style code
random_style?: boolean; // Use random style from library
}
实施示例
基本图像生成
具有质量优化的标准图像生成:
{
"prompt": "Professional corporate office environment with modern design elements",
"aspect_ratio": "16x9",
"rendering_speed": "QUALITY",
"style_type": "REALISTIC"
}
高级样式参考实现
利用风格参考来保持品牌一致性:
{
"prompt": "Modern minimalist logo design for technology company",
"style_reference": {
"urls": ["https://example.com/brand-reference.jpg"],
"random_style": false
},
"style_type": "DESIGN",
"num_images": 4,
"negative_prompt": "cluttered, busy, complex"
}
企业批量处理
大批量生产,结果可重复:
{
"prompt": "Professional product photography for e-commerce catalog",
"rendering_speed": "QUALITY",
"style_type": "REALISTIC",
"negative_prompt": "blurry, low resolution, amateur",
"seed": 12345,
"num_images": 8,
"aspect_ratio": "1x1"
}
创意设计工作流程
具有风格代码的高级创意生成:
{
"prompt": "Artistic poster design with typography and geometric elements",
"style_codes": ["A1B2C3D4", "E5F6G7H8"],
"style_type": "DESIGN",
"magic_prompt": "ON",
"rendering_speed": "QUALITY",
"blur_mask": true
}
开发指南
开发先决条件
- Node.js:18.0.0或更高版本
- TypeScript:版本5.0.0或更高版本
- Git:最新稳定版本
- Ideogram API密钥:有效的API凭据
地方发展设置
克隆和配置开发环境:
git clone https://github.com/Thelyoncrypt/openai-image-1-ideogram-mcp.git
cd openai-image-1-ideogram-mcp
npm install
cp .env.example .env
# Configure your API key in .env file
构建过程
将TypeScript编译为JavaScript:
npm run build
开发工作流程
启用监视模式以进行连续编译:
npm run watch
质量保证
运行完整的测试套件:
npm test
npm run lint
项目架构
openai-image-1-ideogram-mcp/
├── src/ # Source code directory
│ ├── types/
│ │ └── ideogram.ts # TypeScript type definitions
│ ├── tools/
│ │ └── generate-image.ts # Core image generation tool
│ ├── utils/
│ │ └── validation.ts # Input validation utilities
│ ├── ideogram-client.ts # Ideogram API client implementation
│ ├── server.ts # MCP server configuration
│ └── index.ts # Application entry point
├── dist/ # Compiled JavaScript output
├── docs/ # Generated images storage
├── package.json # Package configuration
├── tsconfig.json # TypeScript configuration
├── .env.example # Environment template
├── .gitignore # Git ignore rules
├── LICENSE # MIT license
├── CHANGELOG.md # Version history
└── README.md # Project documentation
配置参考
支持的纵横比
| 类别 | 比率 | 用例 |
|---|---|---|
| 方形 | 1x1 |
社交媒体帖子、头像、徽标 |
| 景观 | 16x9, 4x3, 21x9, 3x2, 5x4, 3x1, 2x1 |
演示文稿、横幅、标题 |
| 肖像 | 9x16, 3x4, 9x21, 2x3, 4x5, 1x3, 1x2 |
移动内容、海报、故事 |
渲染性能选项
| 速度 | 质量 | 用例 | 典型生成时间 |
|---|---|---|---|
| 涡轮 | 好 | 快速原型制作,预览 | ~5-10秒 |
| 默认 | 高 | 标准生产使用 | ~15-30秒 |
| 质量 | 高级 | 最终交付成果,打印 | ~30-60秒 |
样式类型类别
- 自动:基于提示内容的智能风格选择
- 通用:多功能风格,适合大多数应用
- 切合实际的:用于真实图像的照片级真实感渲染
- 设计:针对图形、徽标和创意设计进行了优化
贡献
我们欢迎社区的贡献。请遵循我们的捐款指南:
开发过程
- 分叉 将存储库添加到您的GitHub帐户
- 克隆 你的叉子在当地
- 创建 特征分支(
git checkout -b feature/amazing-feature) - 实施 通过适当的测试进行更改
- 提交 您的更改(
git commit -m 'Add amazing feature') - 推 到您的分行(
git push origin feature/amazing-feature) - 提交 一个带有详细描述的拉取请求
代码规范
- 遵循TypeScript的最佳实践
- 保持测试覆盖率在80%以上
- 使用常规提交消息
- 更新新功能的文档
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取完整的详细信息。
资源和文件
发布说明
1.0.0版本-首次发布
新功能:
- 完成Ideogram v3.0 API集成
- 先进的风格参考系统,支持图像上传
- 可配置的渲染速度优化
- 企业级错误处理和验证
- 具有完全类型安全的专业TypeScript实现
- 具有强大工具定义的全面MCP服务器
技术改进:
- 现代ES2022 TypeScript架构
- 基于Axios的HTTP客户端,具有重试逻辑
- 全面的输入验证和净化
- 模块化设计,关注点分离
- 生产就绪的测井和监测挂钩
由开发 Lyncrypt | 由Ideogram v3.0 API提供支持