README
🚀 MCP TemplateIO - 图像生成工具
MCP TemplateIO 是一个基于 mcp-framework 构建的 MCP 服务器,它提供了基于 Templated.io 的图像生成工具,为用户打造具有自定义工具的 MCP 服务器提供了便利。
🚀 快速开始
# 安装依赖
npm install
# 构建项目
npm run build
✨ 主要特性
- 基于 mcp-framework 构建,提供稳定的 MCP 服务器支持。
- 具备模板化图像生成器,可利用 Templated.io API 基于文本和图像 URL 生成图像。
- 提供工具开发示例,方便用户开发自定义工具。
- 支持使用 CLI 添加更多工具。
- 可将项目发布到 npm,便于共享和使用。
📦 安装指南
全局安装依赖
npm install -g mcp-templateio
创建新项目并运行
mcp new my-project && cd my-project && npm start
在package.json中添加配置
"scripts": {
"start": "mcp start"
}
💻 使用示例
模板化图像生成器
该工具基于模板,使用文本和图像 URL 生成图像,利用了 Templated.io API。
输入参数:
| 参数 | 详情 |
|------|------|
| templateId | Templated.io 模板的 ID |
| photoBgImageUrl | "photo-bg" 层中使用的图像 URL |
| bgYellowImageUrl | "bg-yellow" 层中使用的图像 URL |
| buildText | "build" 文本层中的文本内容 |
🔧 技术细节
项目结构
mcp-templateio/
├── src/
│ ├── tools/ # MCP 工具
│ │ ├── ExampleTool.ts
│ │ └── TemplatedImageTool.ts # 图像生成工具
│ └── index.ts # 服务器入口点
├── package.json
└── tsconfig.json
工具开发示例
import { MCPTool } from "mcp-framework";
import { z } from "zod";
interface MyToolInput {
message: string;
}
class MyTool extends MCPTool<MyToolInput> {
name = "my_tool";
description = "描述您的工具的功能";
schema = {
message: {
type: z.string(),
description: "此输入参数的描述",
},
};
async execute(input: MyToolInput) {
// 您的工具逻辑
return `处理结果:${input.message}`;
}
}
export default MyTool;
添加组件
项目附带了示例工具在src/tools/ExampleTool.ts和TemplatedImageTool.ts。您可以使用 CLI 添加更多工具:
# 添加新工具
mcp add tool my-tool
# 示例工具:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler
发布到 npm
- 更新
package.json:- 确保
name唯一且符合 npm 命名规范。 - 设置适当的
version。 - 添加
description,author,license等信息。 - 检查
bin是否指向正确的入口文件。
- 确保
- 本地构建和测试:
npm run build npm link mcp-templateio # 在本地测试您的 CLI - 登录 npm(如无账号请先创建):
npm login - 发布包:
npm publish
构建与测试
npm run build
npm test
Scan to join WeChat group