MCP Ts Simple Template

🚀 MCP TypeScript Simple Template

A simple TypeScript template for building Model Context Protocol (MCP) servers. This project provides a foundation for creating custom MCP tools that can be integrated with AI systems.

🚀 Quick Start

Prerequisites

• Node.js (version 20 or higher recommended)
• npm or yarn

Installation

1. Clone this repository.
2. Install dependencies:

npm install

Build and Run

Build and start the server:

npm start

This will compile the TypeScript code and start the MCP server.

Development

During development, you can do the following:

1. Modify the index.ts file to add custom tools.
2. Run the build command to compile:

npm run build

✨ Features

This template implements a basic MCP server and comes with an example BMI calculator tool. It demonstrates how to:

• Set up an MCP server using TypeScript.
• Define and implement MCP tools and their input validation using Zod.
• Connect the server to standard I/O for communication.

📦 Installation

1. Clone this repository.
2. Install dependencies:

npm install

📚 Documentation

Project Structure

• index.ts - The main server implementation file with example tools.
• package.json - Project dependencies and scripts.
• tsconfig.json - TypeScript configuration.

Usage

Build and Run

Build and start the server:

npm start

This will compile the TypeScript code and start the MCP server.

Development

During development, you can do the following:

1. Modify the index.ts file to add custom tools.
2. Run the build command to compile:

npm run build

Creating Custom Tools

To create a new tool, follow this pattern in index.ts:

server.tool(
  "your-tool-name",
  {
    // Define the input schema using Zod
    paramName: z.string(),
    // Add more parameters if needed
  },
  async ({ paramName }) => ({
    content: [{
      type: "text",
      text: "Your tool response"
    }]
  })
);

Dependencies

• @modelcontextprotocol/sdk - Core MCP SDK
• zod - Schema validation
• dotenv - Environment variable management
• typescript - TypeScript compiler

📄 License

ISC

Contribution

Contributions are welcome! Please feel free to submit pull requests.