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 <工具名称>

这将：

1. 在 src/tools/<工具名称> 下创建一个新的工具目录
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

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

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: Bug 修复（增加补丁版本号）
• 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"]
    }
  }
}