🎨 Ideogram MCP Server

GitHub GitHub package.json version GitHub issues GitHub pull requests npm npm

这是一个使用Ideogram API提供图像生成的Model Context Protocol (MCP) 服务器！
支持Ideogram 3.0，能够与Claude Desktop和MCP客户端快速集成，非常强大✨

📦 项目概述

这是一个通过MCP服务器使用Ideogram API (v3.0) 的TypeScript工具
提供图像生成、风格参考、魔法提示、宽高比、模型选择等多种功能
可以立即在Claude Desktop和其他MCP客户端中使用

⚡️ 快速开始

如果你想在Claude Desktop或其他MCP客户端中快速集成，
只需将以下JSON代码片段复制到配置文件中即可！✨

{
  "mcpServers": {
    "ideogram": {
      "command": "npx",
      "args": [
        "@sunwood-ai-labs/ideagram-mcp-server"
      ],
      "env": {
        "IDEOGRAM_API_KEY": "your_api_key_here"
      }
    }
  }
}

🛠️ MCP工具规范

generate_image

参数列表（最新版）

参数	类型	说明	必填/可选	备注
prompt	string	图像生成提示（推荐使用英语）	必填
aspect_ratio	string	宽高比（例如："1x1", "16x9", "4x3" 等）	可选	15种选项
resolution	string	分辨率（请参考官方文档，共69种）	可选
seed	integer	随机种子（用于保证重现性）	可选	0～2147483647
magic_prompt	string	魔法提示（"AUTO"	"ON"	"OFF"）
rendering_speed	string	v3渲染速度（"TURBO"	"DEFAULT"	"QUALITY"）
style_codes	string[]	8字符风格代码数组	可选
style_type	string	风格类型（"AUTO"	"GENERAL"	"REALISTIC"
negative_prompt	string	排除元素（推荐使用英语）	可选
num_images	number	生成图像数量（1～8）	可选
style_reference	object	风格参考（Ideogram 3.0新功能）	可选	详见下文
└ urls	string[]	参考图像URL数组（最多3个）	可选
└ style_code	string	风格代码	可选
└ random_style	boolean	使用随机风格	可选
output_dir	string	图像保存目录（默认: "docs"）	可选
base_filename	string	保存文件名的基名（默认: "ideogram-image"）	可选	自动添加时间戳和ID
blur_mask	boolean	模糊图像边缘（true时进行蒙版合成）	可选	默认: false

📝 使用示例

const result = await use_mcp_tool({
  server_name: "ideagram-mcp-server",
  tool_name: "generate_image",
  arguments: {
    prompt: "A beautiful sunset over mountains",
    aspect_ratio: "16x9",
    rendering_speed: "QUALITY",
    num_images: 2,
    style_reference: {
      urls: [
        "https://example.com/ref1.jpg",
        "https://example.com/ref2.jpg"
      ],
      random_style: false
    },
    blur_mask: true
  }
});

🧑‍💻 开发、构建、测试

npm run build ... TypeScript构建
npm run watch ... 开发模式（自动构建）
npm run lint ... 代码检查
npm test ... 运行测试

🗂️ 目录结构

ideagram-mcp-server/
├── assets/
├── docs/
│   └── ideogram-image_2025-05-18T06-31-45-777Z.png
├── src/
│   ├── tools/
│   ├── types/
│   ├── utils/
│   ├── ideogram-client.ts
│   ├── index.ts
│   ├── server.ts
│   └── test.ts
├── .env.example
├── package.json
├── tsconfig.json
├── README.md
└── ...（省略）

📝 贡献指南

Fork 这个仓库
创建一个新分支 (git checkout -b feature/awesome)
提交你的更改（推荐使用日语+表情符号的提交信息！）
推送并创建Pull Request

🚀 部署与发布

通过GitHub Actions自动发布到npm
更新版本并推送标签以自动部署

npm version patch|minor|major
git push --follow-tags

详情请参考 docs/npm-deploy.md！

📄 许可证

MIT