MCP Server Starter

MCP 服务入门模板

用于使用 TypeScript 构建 Model Context Protocol（MCP）服务的生产就绪入门模板。

🚀 快速开始

1. 克隆仓库
2. 安装依赖：

   bun install
   

✨ 主要功能

• 使用 Bun 加快测试和开发
• 使用 Biome 进行代码检查和格式化
• 使用 standard-version 自动管理版本
• 清晰、易维护的项目结构

📂 项目结构

mcp-starter/
├── src/
│   ├── tools/          # MCP tools implementation
│   ├── utils/          # Shared utilities
│   ├── main.ts         # Server entry point
│   └── types.ts        # Shared type definitions
├── tests/              # Test files
├── biome.json          # Linting configuration
├── tsconfig.json       # TypeScript configuration
└── package.json        # Project dependencies

⚙️ 配置

创建新工具

项目提供了一个用于创建新 MCP 工具的脚本：

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

此脚本将：

1. 在 src/tools/<tool-name> 下创建新的工具目录
2. 生成基本工具结构，包括：
   • index.ts（主要实现）
   • schema.ts（工具参数的 JSON schema）
   • test.ts（测试文件）
3. 更新工具索引文件，以导出新工具

示例：

bun run scripts/create-tool.ts weather

🛠️ 开发

• 运行测试：bun test
• 格式化代码：bun run format
• 检查代码：bun run lint
• 构建项目：bun run build

要将开发中的 MCP 服务添加到 Claude Desktop：

1. 构建项目：

   bun run build
   

2. 添加到 Claude Desktop 配置：

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

📜 版本管理

本项目使用 standard-version 自动管理版本。运行 bun run release 可创建新版本。

提交消息格式

• feat：新功能（升级次版本号）
• fix：错误修复（升级修订版本号）
• BREAKING CHANGE：不兼容的变更（升级主版本号）

📦 发布到 npm

1. 确保已登录 npm：

   npm login
   

2. 构建项目：

   bun run build
   

3. 发布软件包：

   npm publish
   

发布新版本前，请记得使用 bun run release 更新版本号。

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 Weather MCP Server Starter：

npx -y @smithery/cli install @GreatAuk/mcp-weather --client claude

从 npm 安装（发布后）

添加到 Claude Desktop 配置：

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