MCP Template Node

🚀 MCP Template Node

A Node.js/TypeScript template for creating Model Context Protocol (MCP) servers. This template demonstrates a simple note management system using the MCP protocol.

🚀 Quick Start

Prerequisites

• Node.js 18 or higher
• npm or yarn

Steps

1. Clone the repository:

git clone https://github.com/Rethunk-Tech/mcp-template-node.git
cd mcp-template-node

2. Install dependencies:

yarn install

3. Build and run the server:

yarn build
yarn start

✨ Features

• Implemented in TypeScript with strict type checking
• A simple note management system with basic CRUD operations
• A complete example of MCP concepts (tools, resources, prompts)
• In-memory note storage
• Comprehensive error handling and validation
• Unit tests with Vitest
• VS Code debugging configuration
• GitHub Actions CI workflow for testing and building

📚 Documentation

What is MCP?

Model Context Protocol (MCP) is a standardized way for applications to provide context to large language models (LLMs). For more information, visit the official MCP protocol website.

Project Structure

mcp-template-node/
├── build/                # Compiled JavaScript files
├── src/
│   ├── __tests__/        # Integration tests and testing tools
│   ├── errors/           # Custom error classes
│   ├── tools/            # MCP tool implementations
│   │   └── __tests__/    # Unit tests for tools
│   ├── types/            # TypeScript type definitions
│   │   └── __tests__/    # Type tests
│   └── index.ts          # Main server entry file with MCP example
├── package.json          # Project configuration
├── tsconfig.json         # TypeScript configuration
├── eslint.config.mjs     # ESLint flat configuration
└── README.md             # Project documentation

Development

• Start the TypeScript compiler in watch mode: yarn dev
• Check code formatting: yarn lint
• Fix formatting issues: yarn lint:fix
• Run tests: yarn test

Testing

This project includes comprehensive tests to verify the functionality of the MCP server and its tools.

Running Tests

• Run all tests:

yarn test

• Run tests in watch mode (rerun on file changes):

yarn test:watch

• Run tests with coverage:

yarn test:coverage

Test Structure

• Unit tests: Located in the __tests__ folder with annotated examples
• Integration tests: Located in the src/__tests__/integration folder
• Coverage reports: Generated in the coverage folder

Extending the Template

To extend this template, follow these steps:

1. Create a config.ts file in the project root directory and define the following:

export interface Config {
  environment: 'development' | 'production';
  port: number;
  apiPrefix: string;
}

export const config: Config = {
  environment: process.env.NODE_ENV || 'development',
  port: parseInt(process.env.PORT) || 3000,
  apiPrefix: '/api'
};

2. Create custom tools in the src/tools folder.

Contribution Guidelines

To contribute to the project, follow these steps:

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to your fork
5. Submit a pull request

📄 License

[Add license information here]

Contact

• Email: [Add email address here]
• GitHub: [Add GitHub username or link here]