TypeScript MCP Server Template

# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.0.0] - 2025-07-25 ### Added - **Initial Release** - Complete TypeScript MCP Server Template - **MCP Server Implementation** - Full Model Context Protocol server with HTTP and STDIO transport - **Fastify Integration** - High-performance web framework for building APIs - **TypeScript Support** - Full type safety and modern TypeScript features - **Tool Implementation** - Hello and Weather tools with Zod validation - **Resource Management** - Basic resource handling for MCP protocol - **Error Handling** - Centralized error handling utilities - **Structured Logging** - Pino-based logging with pretty formatting for development ### Development Experience - **Hot Reload** - Development server with tsx for instant feedback - **Code Quality Tools** - ESLint and Prettier configuration - **Git Hooks** - Husky and lint-staged for pre-commit quality checks - **Type Checking** - TypeScript compilation and validation - **Build Process** - Clean build with proper npm scripts - **Environment Configuration** - env.example for easy setup ### Docker & Deployment - **Multi-stage Docker Build** - Optimized production images - **Docker Compose** - Development and production setups - **Security** - Non-root user execution, minimal base image - **Healthchecks** - Proper monitoring with curl - **Performance** - Optimized with comprehensive .dockerignore - **Documentation** - Complete Docker troubleshooting and best practices guides ### Documentation - **Comprehensive README** - Complete project documentation - **Spanish README (README_ES.md)** - Complete documentation for non-English speakers - **API Documentation** - Endpoints and usage examples - **Docker Guides** - Troubleshooting and best practices - **Getting Started** - Clear setup instructions - **Client Example** - JavaScript client for testing MCP features - **Troubleshooting** - Common issues and solutions ### Technical Features - **CORS Support** - Cross-origin resource sharing for web clients - **Session Management** - MCP session handling and isolation - **Plugin Architecture** - Modular plugin system for easy extension - **Validation** - Zod schemas for runtime type validation - **Configuration** - Centralized configuration management ### Dependencies - **@modelcontextprotocol/sdk** - Official MCP TypeScript SDK - **fastify** - Fast and efficient web framework - **zod** - Runtime type validation - **pino** - Structured logging - **@fastify/cors** - CORS support - **tsx** - TypeScript execution without compilation ### Development Dependencies - **typescript** - TypeScript compiler (v5.5.3) - **eslint** - Code linting - **prettier** - Code formatting - **husky** - Git hooks - **lint-staged** - Pre-commit linting - **rimraf** - Cross-platform rm -rf ### Breaking Changes - None (Initial Release) ### Known Issues - Some ESLint warnings for `any` types (non-blocking) - Console statements in server.ts (development logging) ### Contributors - **Diego Hinojosa Córdova** - Initial implementation and documentation --- ## [Unreleased] ### Planned Features - Unit and integration tests - Additional MCP tools and resources - Performance optimizations - Enhanced error handling - More comprehensive documentation - CI/CD pipeline improvements ### Known Issues - None currently tracked --- ## Release Notes ### v1.0.0 - Initial Release This is the first public release of the TypeScript MCP Server Template. It provides a complete foundation for building MCP servers with TypeScript, including: - **Production-ready Docker setup** with security best practices - **Comprehensive documentation** for developers - **Modern development workflow** with hot reload and quality tools - **MCP protocol compliance** with both HTTP and STDIO transport - **Extensible architecture** for adding custom tools and resources This template follows the official MCP TypeScript SDK best practices and is designed to be a starting point for building production MCP servers. ### Getting Started 1. Clone the repository 2. Run `npm install` 3. Copy `env.example` to `.env` and configure 4. Run `npm run dev` for development 5. Use `docker-compose up` for containerized deployment For detailed instructions, see the [README.md](README.md) file.