Ideogram MCP Server 简介
本仓库提供了一个基于 Model Context Protocol (MCP) 的服务器实现,它允许 LLM 客户端通过标准的 MCP 协议调用 Ideogram API 的图像生成功能。通过此服务器,用户可以方便地集成图像生成能力到各种 LLM 应用中。
主要功能点
- 图像生成: 支持通过文本提示词生成图像,利用 Ideogram AI 的强大图像生成能力。
- 可定制参数: 提供丰富的图像生成参数,包括:
- 图像比例 (aspect ratio)
- 生成模型选择
- Magic Prompt 选项
- 风格类型 (style type)
- 负面提示词 (negative prompt)
- 生成图像数量
- MCP 协议支持: 完全兼容 Model Context Protocol,可以通过 JSON-RPC 协议与 MCP 客户端进行通信。
- 工具注册: 注册 'generate_image' 工具,方便 LLM 客户端发现和调用图像生成功能。
- 环境配置: 通过简单的环境变量配置 Ideogram API 密钥。
安装步骤
-
安装依赖: 在项目根目录下运行以下命令安装必要的 npm 包:
npm install -
配置环境变量: 创建 '.env' 文件,并添加 Ideogram API 密钥:
IDEOGRAM_API_KEY=your_api_key_here请替换 'your_api_key_here' 为您在 Ideogram 平台申请的 API 密钥。
-
构建项目: 运行以下命令编译 TypeScript 代码:
npm run build -
全局安装 (可选): 为了更方便地从任何位置运行服务器,您可以选择全局安装:
npm link
服务器配置 (MCP 客户端)
MCP 客户端需要配置以下信息以连接到 Ideogram MCP 服务器。以下是一个 JSON 格式的配置示例,请根据您的实际安装情况进行调整。
{ "server_name": "ideogram-mcp-server", "command": "ideogram-mcp-server", "args": [] }
配置参数说明:
- 'server_name': 服务器名称,固定为 'ideogram-mcp-server'。
- 'command': 服务器启动命令。
- 如果您执行了 'npm link' 进行全局安装,可以直接使用 'ideogram-mcp-server' 命令。
- 如果您没有全局安装,或者希望直接从项目目录运行,则需要指定 'node' 命令和构建后的 'index.js' 文件路径,例如: '"command": "node"', '"args": ["path/to/ideogram-mcp-server/dist/index.js"]' (请根据实际路径调整)。
- 'args': 启动参数,本服务器无需额外启动参数,保持为空数组 '[]' 即可。
注意: 确保 MCP 客户端能够访问到 'ideogram-mcp-server' 命令(或 'node' 命令和 'index.js' 文件)。
基本使用方法
-
启动 MCP 服务器: 在终端中运行服务器启动命令。如果您已全局安装,直接运行 'ideogram-mcp-server' 即可。服务器成功启动后,会在标准错误输出 (stderr) 中打印 'Ideogram MCP server running on stdio'。
-
配置 MCP 客户端: 将上述服务器配置 JSON 添加到您的 MCP 客户端配置中。
-
调用 'generate_image' 工具: 在 MCP 客户端中,您可以使用 'generate_image' 工具来生成图像。以下是一个调用示例(以 TypeScript 代码为例,具体取决于您的 MCP 客户端实现):
const result = await use_mcp_tool({ server_name: "ideogram-mcp-server", tool_name: "generate_image", arguments: { prompt: "A futuristic cityscape at sunset", aspect_ratio: "ASPECT_16_9", num_images: 1 } }); if (result && result.content) { console.log("Image generation result:"); result.content.forEach(item => { if (item.type === 'text') { console.log(item.text); // 打印生成结果,包含图片 URL 和本地保存路径 } }); }请参考 'README.md' 文件中的 "使用例" 部分,了解更多 'generate_image' 工具的参数和使用方法。
通过以上步骤,您就可以利用 Ideogram MCP Server 将强大的图像生成能力集成到您的 LLM 应用中。
信息
分类
AI与计算