Custom MCP Template

🚀 MCP Server Template (create-mcp-server)

This template helps you quickly kickstart a new Model Context Protocol (MCP) server project and configures it based on recommended practices.

🚀 Quick Start

Create a New Server

To create a new MCP server project named my-new-mcp-server, run the following command:

npx create-mcp-server my-new-mcp-server

(Note: If this package has not been published to npm, run npm link in the template directory first, then use create-mcp-server my-new-mcp-server)

This will perform the following actions:

1. Create a new directory named my-new-mcp-server.
2. Prompt you to enter project details (name, description).
3. Copy template files (src, docs, configuration files, etc.) to the new directory.
4. Update package.json with your project details.

After initialization, follow the instructions in the terminal:

cd my-new-mcp-server
npm install
# Check the configuration in src/config/ConfigurationManager.ts
# Add your tools in src/tools/
# Add your services in src/services/
npm run dev  # Start the development server

💻 Usage Examples

Develop this Template (Advanced)

This section describes the structure and development process of the mcp-server-template itself. You usually don't need this information if you're just using the template to create your own server.

Project Structure

• /src: Contains all source code.
  • /config: Configuration management (ConfigurationManager).
  • /services: Core business logic classes.
  • /tools: MCP tool definitions and adapters (Tool.ts, Params.ts).
  • /types: TypeScript interfaces and Zod schemas.
  • /utils: Shared utility functions (logging, error handling, etc.).
  • initialize.ts: Server instance creation and tool registration.
  • server.ts: Main application entry point.
• /dist: Compiled JavaScript output (generated by npm run build).
• package.json: Project metadata and dependencies.
• sconfig.json: TypeScript compiler options.
• .eslintrc.json: ESLint configuration.
• .prettierrc.json: Prettier configuration.
• .gitignore: Git ignore rules.

Getting Started

1. Install dependencies:

   npm install
   

2. Configure Husky (if needed, on the first run):

   npx husky install
   

3. Run in development mode: (with s-node and odemon for automatic reloading)

   npm run dev
   

4. Build for production:

   npm run build
   

5. Run the production build:

   npm start
   

Add a New Tool (yourTool)

1. Define types: Create src/types/yourServiceTypes.ts, containing interfaces (e.g., YourServiceConfig, YourServiceData). Export from src/types/index.ts.
2. Implement the service: Create src/services/yourService.ts and implement the service logic as needed.
3. Define tool parameters: Export type definitions in src/tools/yourToolParams.ts.
4. Register the tool: Add your tool to the tools array in src/initialize.ts.
5. Run and test: Start the server with npm run dev and test the new tool by accessing /api/your_tool.

Code Checks

1. Linting:

   npm run lint
   

2. Formatting:

   npm run format
   

These commands will help you keep your code clean and consistent.