MCP Starter Template

🚀 MCP Server Starter Template

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 fast testing and development.
• Employ Biome for code linting and formatting.
• Automate version management with standard-version.
• Provide a clean and maintainable project structure.

📂 Project Structure

mcp-starter/
├── src/
│   ├── tools/          # MCP tool implementations
│   ├── utils/          # Shared utility functions
│   ├── 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

The project includes a script to help create new MCP tools:

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

This command will:

1. Create a new tool directory under src/tools/<tool-name>.
2. Generate the basic tool structure, including:
   • index.ts (the main implementation of the tool)
   • schema.ts (the JSON schema for tool parameters)
   • test.ts (the 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

Add your development MCP server to Claude Desktop:

1. Build the project:

bun run build

2. Update 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

Remember to update the version number using bun run release before publishing a new version.

📦 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"]
    }
  }
}