README
🚀 重构 MCP 服务器
这是一个实现与 Recraft.ai 服务集成的 Model Context Protocol (MCP) 服务器。借助该服务器,AI 助手能够通过 Recraft 的 API,利用 MCP 框架来生成图像。
🚀 快速开始
此服务器允许 AI 助手通过 Recraft 的 API 使用 MCP 框架生成图像,为图像生成工作提供了便利的解决方案。
✨ 主要特性
- 实现了 Recraft 图像生成服务的 MCP 工具,可无缝对接 Recraft 服务。
- 使用 Zod 进行类型安全的模式验证,确保数据的准确性和安全性。
- 支持多种图像生成选项(风格、大小等),满足多样化的图像生成需求。
- 方便与支持 MCP 的 LLM 助手集成,拓展应用场景。
📦 安装指南
先决条件
- Node.js (建议 v18 或更高版本)
- 从 recraft.ai 获取的 Recraft API 密钥
安装步骤
- 克隆仓库:
git clone https://github.com/yourusername/recraft-mcp-server.git
cd recraft-mcp-server
- 安装依赖项:
npm install
- 复制环境文件并配置您的 API 密钥:
cp .env.example .env
然后编辑 .env 并添加您的 Recraft API 密钥。
🔧 配置
服务器使用以下环境变量:
| 属性 | 详情 |
|------|------|
| RECRAFT_API_URL | Recraft API 终端点 (默认: https://external.api.recraft.ai) |
| RECRAFT_API_KEY | 您的 Recraft API 密钥 |
💻 使用示例
基础用法
构建服务器
npm run build
启动服务器
npm start
或使用提供的 shell 脚本:
./start-mcp.sh
开发模式
npm run dev
检查 MCP 服务器
MCP SDK 包含一个检查工具来测试服务器:
npm run inspect
高级用法
运行测试
npm test
带覆盖范围的测试
npm run test:coverage
带有观察模式的测试
npm run test:watch
📚 详细文档
验证
该项目使用 Zod 进行模式验证。有关实现细节,请参阅 ZOD_IMPLEMENTATION.md。
API
此服务器实现了以下 MCP 工具:
generate_image:从文本提示生成图像image_to_image:使用文本提示转换现有图像inpaint_image:使用遮罩编辑图像的一部分replace_background:替换图像的背景vectorize_image:将位图图像转换为矢量格式remove_background:从图像中移除背景crisp_upscale:带有增强细节和清晰度的图像放大creative_upscale:带有创意增强的图像放大create_style:使用参考图像创建新风格get_user_info:获取当前用户的信息save_image_to_disk:将生成的图像保存到本地文件系统
服务器还响应一个特殊的 help 命令,提供有关可用工具的一般信息,但这是作为服务器逻辑中的特殊情况处理的,而不是正式的工具定义。
有关每个工具的可用参数和选项的详细信息,请使用 MCP 检查工具或查看代码中的工具定义。
开发
代码检查和修复
# 运行类型检查
npm run type-check
# 运行 eslint
npm run lint
# 修复 linting 问题
npm run lint:fix
# 同时运行类型检查和 linting
npm run validate
📄 许可证
本项目采用 MIT 许可证。
扫码联系在线客服