article
README
🚀 🎨 Ideogram MCP 服务器
Ideogram MCP 服务器基于 Model Context Protocol (MCP),借助 Ideogram API 实现图像生成功能,为用户提供便捷的图像创作体验。
🚀 快速开始
环境准备
请确保你的环境已经安装好 npm 和 git。
安装与配置
- 安装依赖:在项目根目录下执行以下命令,安装所需的依赖项。
npm install
- 设置环境变量:创建一个
.env文件,并添加你的 Ideogram API 密钥。
IDEOGRAM_API_KEY=your_api_key_here
- 项目构建:执行以下命令完成项目构建。
npm run build
- (可选)全局安装:若你需要在全局使用该工具,可执行以下命令。
npm link
✨ 主要特性
- 图像生成:根据用户输入的提示信息生成高质量的图像。
- 参数自定义:支持多种参数自定义,包括宽高比、模型选择、魔法提示、风格类型、负面提示以及生成图像数量等。
📦 安装指南
依赖安装
npm install
环境变量配置
创建 .env 文件并添加如下内容:
IDEOGRAM_API_KEY=your_api_key_here
项目构建
npm run build
全局安装(可选)
npm link
💻 使用示例
MCP 工具 - generate_image
generate_image 是用于生成图像的工具,以下是其使用说明:
必需参数
prompt:生成图像所使用的提示信息。
可选参数
aspect_ratio:图像的宽高比,可选值有ASPECT_1_1、ASPECT_4_3、ASPECT_3_4、ASPECT_16_9、ASPECT_9_16。model:使用的模型,可选值有V_1、V_1_TURBO、V_2、V_2_TURBO。magic_prompt_option:魔法提示设置,可选值有AUTO、ON、OFF。style_type:生成风格。negative_prompt:要排除的内容描述。num_images:要生成的图像数量,范围为 1 - 8。
代码示例
const result = await use_mcp_tool({
server_name: "ideagram-mcp-server",
tool_name: "generate_image",
parameters: {
prompt: "a beautiful sunset over the mountains"
}
});
📚 详细文档
开发指南
克隆仓库
git clone https://github.com/sunwood-ai-labs/ideagram-mcp-server.git
cd ideagram-mcp-server
安装依赖
npm install
启动开发服务器
npm run dev
项目构建
npm run build
运行测试
npm test
贡献指南
- 创建分支:Fork 仓库并在本地克隆后,创建一个新的功能分支。
git checkout -b feature/new-feature
- 提交更改:完成代码修改后,将更改提交并推送到远程仓库。
git add .
git commit -m "添加新功能"
git push origin feature/new-feature
- 创建 Pull Request:在 GitHub 上创建一个 Pull Request 到主分支。
微信扫一扫