MCP Server Template

🚀 MCP Server Template

A comprehensive template for building Model Context Protocol (MCP) servers using TypeScript and Node.js.

🚀 Quick Start

This template provides a standardized structure and best practices for developing MCP servers. It includes:

• TypeScript configuration using ES modules
• Standardized directory structure
• Error handling tools
• Testing framework
• Example implementations
• Comprehensive documentation

Start the Server

# Clone this repository
git clone https://github.com/your-org/mcp-server-template.git my-mcp-server

# Navigate to the project directory
cd my-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

# Run the example server
npm start

Quick Start with LLMs

This template is designed to seamlessly integrate with AI assistants (such as Claude) to aid in the development of MCP servers:

1. Clone this repository:

   git clone https://github.com/your-org/mcp-server-template.git my-mcp-server
   cd my-mcp-server
   

2. Install dependencies:

   npm install
   

3. Copy the prompts from PROMPT_TEMPLATE.md or AI_ASSISTANT_PROMPT.md and paste them into a conversation with Claude or another LLM.

4. Fill in the details of your specific MCP server requirements.

5. Use the LLM to implement custom tools, resources, and other features.

6. Test using the included testing tools:

   npm test
   

7. Deploy your MCP server as needed.

📦 Directory Structure

mcp-server-template/
├── package.json           # Configured as an ES module
├── tsconfig.json          # TypeScript configuration
├── README.md              # Documentation and usage examples
├── PROMPT_TEMPLATE.md     # Templates for task-specific LLM assistants
├── AI_ASSISTANT_PROMPT.md # Role prompts for AI assistants with in-depth MCP expertise
├── DEVELOPMENT_RULES.md   # Development guidelines
├── src/
│   ├── index.ts           # Main server implementation
│   ├── tools/             # Example tool implementations
│   │   └── example-tool.ts
│   ├── resources/         # Example resource implementations
│   │   └── example-resource.ts
│   └── utils/             # Helper tools
│       └── error-handling.ts
├── tests/                 # Test scripts
│   └── server.test.js
├── docs/                  # Detailed documentation
│   ├── client-developers.md
│   ├── server-developers.md
│   ├── claude-users.md
│   └── mcp-reference.md
└── examples/              # Example implementations
    ├── weather-server/    # Example using the National Weather Service API
    ├── github-server/     # Example using the GitHub API
    └── local-files-server/ # Example using the local file system

✨ Features

MCP Server Implementation

The template includes a basic MCP server implementation with:

• Protocol version negotiation
• Capability declaration
• Tool registration and execution
• Resource management
• Error handling
• Logging

Tools and Resources

Example implementations include:

• Basic tools with parameter validation
• Resource definitions using URI templates
• Prompt templates

Testing

The template includes a testing framework for:

• Unit testing of tools and resources
• Integration testing with MCP clients
• Mocking external dependencies

📚 Documentation

Comprehensive documentation is included in the docs/ directory.

📋 Development Rules

Follow the guidelines in DEVELOPMENT_RULES.md to learn how to contribute code.

💻 Usage Examples

Check out the example implementations in the examples/ directory to learn how to use the MCP server template.

🤝 Contribution Guidelines

Read CONTRIBUTING.md to learn how to contribute to the project.