Templateio

🚀 MCP TemplateIO - Image Generation Tool

An MCP server built with the mcp-framework, offering an image generation tool based on Templated.io.

🚀 Quick Start

# Install dependencies
npm install

# Build the project
npm run build

✨ Features

This template serves as a starting point for building an MCP server with custom tools. It includes a sample tool and provides instructions on adding more tools, developing them, and publishing them to npm. This README will guide you through the process of setting up, developing, and deploying your own MCP server.

📦 Installation

Project Structure

mcp-templateio/
├── src/
│   ├── tools/        # MCP tools
│   │   ├── ExampleTool.ts
│   │   └── TemplatedImageTool.ts # Image generation tool
│   └── index.ts      # Server entry point
├── package.json
└── tsconfig.json

Available Tools

Templated Image Generator

This tool is template-based and generates images using text and image URLs, leveraging the Templated.io API.

Input Parameters:

• templateId: The ID of the Templated.io template.
• photoBgImageUrl: The URL of the image used in the "photo-bg" layer.
• bgYellowImageUrl: The URL of the image used in the "bg-yellow" layer.
• buildText: The text content in the "build" text layer.

💻 Usage Examples

Tool Development

The structure of a tool example:

import { MCPTool } from "mcp-framework";
import { z } from "zod";

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "Describe the functionality of your tool";

  schema = {
    message: {
      type: z.string(),
      description: "Description of this input parameter",
    },
  };

  async execute(input: MyToolInput) {
    // Your tool logic
    return `Processing result: ${input.message}`;
  }
}

export default MyTool;

Adding Components

The project comes with sample tools in src/tools/ExampleTool.ts and TemplatedImageTool.ts. You can use the CLI to add more tools:

# Add a new tool
mcp add tool my-tool

# Example tools:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

Publishing to npm

1. Update package.json:
   • Ensure the name is unique and complies with npm naming conventions.
   • Set an appropriate version.
   • Add information such as description, author, license, etc.
   • Check that bin points to the correct entry file.
2. Build and test locally:

   npm run build
   npm link
   mcp-templateio  # Test your CLI locally
   

3. Log in to npm (create an account if you don't have one):

   npm login
   

4. Publish the package:

   npm publish
   

Using Claude Desktop

# Install dependencies globally
npm install -g mcp-templateio

# Create a new project and run it
mcp new my-project && cd my-project && npm start

Add the following configuration to package.json:

"scripts": {
  "start": "mcp start"
}

Building and Testing

npm run build
npm test

📚 Documentation

• MCP Framework GitHub
• MCP Framework Documentation