A lightweight, ready-to-use TypeScript template for building Model Context Protocol (MCP) servers. This template provides the essential scaffolding to create custom AI tools that can be seamlessly integrated with large language models.
Documentation
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.
Overview
This template implements a basic MCP server with a sample BMI calculator tool. It demonstrates how to:
- Set up an MCP server in TypeScript
- Define and implement MCP tools with input validation using Zod
- Connect the server to standard I/O for communication
Prerequisites
- Node.js (v20 or higher recommended)
- npm or yarn
Installation
1. Clone this repository
2. Install dependencies:
npm installProject Structure
index.ts- Main server implementation with sample toolpackage.json- Project dependencies and scriptstsconfig.json- TypeScript configuration
Usage
Building and Running
Build and start the server:
npm startThis will compile the TypeScript code and start the MCP server.
Development
For development, you can:
1. Modify index.ts to add your own tools
2. Run the build command to compile:
npm run buildCreating Custom Tools
To create a new tool, follow this pattern in index.ts:
server.tool(
"your-tool-name",
{
// Define input schema using Zod
paramName: z.string(),
// Add more parameters as needed
},
async ({ paramName }) => ({
content: [{
type: "text",
text: "Your tool's response"
}]
})
);Dependencies
@modelcontextprotocol/sdk- Core MCP SDKzod- Schema validationdotenv- Environment variable managementtypescript- TypeScript compiler
License
ISC
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Similar MCP
Based on tags & features
Trending MCP
Most active this week