MCP 服务器启动器

一个用于使用 TypeScript 构建 Model Context Protocol (MCP) 服务器的生产就绪启动模板。

🚀 快速开始

1. 克隆仓库
2. 安装依赖：
   bash
   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 工具：

bash
bun run scripts/create-tool.ts

这将：

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

示例：
bash
bun run scripts/create-tool.ts weather

🛠️ 开发

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

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

1. 构建项目：
   bash
   bun run build

2. 添加到您的 Claude Desktop 配置中：
   json
   // 如果需要向您的服务器传递参数，则只需要该参数
   {
   "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：
   bash
   npm login

2. 构建项目：
   bash
   bun run build

3. 发布包：
   bash
   npm publish

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

从 npm 安装（发布后）

添加到您的 Claude Desktop 配置中：
json
// 如果需要向您的服务器传递参数，则只需要该参数
{
"mcpServers": {
"your-server-name": {
"command": "npx",
"args": ["-y", "your-package-name", "some_argument"]
}
}
}