MCP Server Starter

🚀 MCP Server Starter

A production-ready starter template for building Model Context Protocol (MCP) servers using TypeScript.

🚀 Quick Start

1. Clone the repository.
2. Install dependencies:

   bun install
   

✨ Features

• Use Bun for rapid testing and development.
• Use Biome for code linting and formatting.
• Automatic version management with standard-version.
• A clear and maintainable project structure.

📂 Project Structure

mcp-starter/
├── src/
│   ├── tools/          # MCP tool implementations
│   ├── utils/          # Shared utility classes
│   ├── main.ts         # Server entry point
│   └── types.ts        # Shared type definitions
├── tests/              # Test files
├── biome.json          # Code linting configuration
├── tsconfig.json       # TypeScript configuration
└── package.json        # Project dependencies

⚙️ Configuration

Create a New Tool

This project provides a script to help create new MCP tools:

bun run scripts/create-tool.ts <tool-name>

This command will perform the following actions:

1. Create a new tool directory under src/tools/<tool-name>.
2. Generate the basic tool structure, including:
   • index.ts (main implementation)
   • schema.ts (JSON schema for tool parameters)
   • test.ts (test file)
3. Update the tool index file to export the new tool.

Example:

bun run scripts/create-tool.ts weather

🛠️ Development

• Run tests: bun test
• Format code: bun run format
• Lint code: bun run lint
• Build the project: bun run build

To add your development MCP server to Claude Desktop:

1. Build the project:

   bun run build
   

2. Add it to your Claude Desktop configuration:

   // This parameter is only required if you need to pass arguments to the server
   {
     "mcpServers": {
       "your-server-name": {
         "command": "node",
         "args": ["/path/to/your/project/dist/main.js", "some_argument"]
       }
     }
   }
   

📜 Version Management

This project uses standard-version for automated version management. Run bun run release to create a new version.

Commit Message Format

• feat: New features (increment the minor version).
• fix: Bug fixes (increment the patch version).
• BREAKING CHANGE: Breaking changes (increment the major version).

📦 Publish to npm

1. Make sure you are logged in to npm:

   npm login
   

2. Build the project:

   bun run build
   

3. Publish the package:

   npm publish
   

Before publishing a new version, use bun run release to update the version number.

Install from npm (after publishing)

Add the following to your Claude Desktop configuration:

// This parameter is only required if you need to pass arguments to the server
{
  "mcpServers": {
    "your-server-name": {
      "command": "npx",
      "args": ["-y", "your-package-name", "some_argument"]
    }
  }
}

To start the server, run:

npx your-package-name

💻 Usage Examples

Basic Usage

// In src/main.ts
import { createServer } from 'http';

const server = createServer((req, res) => {
  res.writeHead(200);
  res.end('Hello MCP Server!');
});

server.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

Build and run:

bun run build && bun run start