MCP Server Starter

🚀 MCP 服務器啟動器

一個適合生產的起始模板，用於使用 TypeScript 構建 Model Context Protocol (MCP) 服務器，能幫助開發者快速搭建和啟動 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

💻 使用示例

基礎用法

在 src/main.ts 中：

import { createServer } from 'http';

const server = createServer((req, res) => {
  res.writeHead(200);
  res.end('Hello MCP Server!');
});

server.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

構建並運行：

bun run build && bun run start

📚 詳細文檔

開發相關命令

• 運行測試：bun test
• 格式化代碼：bun run format
• 檢查代碼：bun run lint
• 構建項目：bun run build

添加到 Claude Desktop

要將你的開發 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：修復問題（遞增補丁版本號）
• 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"]
    }
  }
}

要啟動服務器，請運行：

npx your-package-name