MCP Server Starter

一个用于使用TypeScript构建模型上下文协议（MCP）服务器的生产就绪启动模板。

🚀 快速开始

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

   bun install
   

✨ 主要特性

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

📂 项目结构

mcp-starter/
├── src/
│   ├── tools/          # MCP工具实现
│   ├── utils/          # 共享工具
│   ├── main.ts         # 服务器入口点
│   └── types.ts        # 共享类型定义
├── tests/              # 测试文件
├── biome.json          # 检查配置
├── tsconfig.json       # TypeScript配置
└── package.json        # 项目依赖

⚙️ 配置

创建新工具

项目中包含一个脚本，帮助创建新的MCP工具：

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

这将：

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

示例：

bun run scripts/create-tool.ts weather

🛠️ 开发

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

要在Claude Desktop中添加你的开发MCP服务器：

1. 构建项目：

   bun run build
   

2. 添加到你的Claude Desktop配置：

   // 如果需要向服务器传递参数，只需要参数部分
   {
     "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更新版本号。

从npm安装（发布后）

添加到你的Claude Desktop配置：

// 如果需要向服务器传递参数，只需要参数部分
{
  "mcpServers": {
    "your-server-name": {
      "command": "npx",
      "args": ["-y", "your-package-name", "some_argument"]
    }
  }
}