MCP Zenon

🚀 MCP 服务器启动模板

这是一个用于构建 Model Context Protocol (MCP) 服务器的生产就绪 starter 模板，采用 TypeScript 编写，能助力开发者高效搭建 MCP 服务器。

🚀 快速开始

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

bun install

✨ 主要特性

• 借助 Bun 实现快速测试和开发，提升开发效率。
• 利用 Biome 进行代码检查和格式化，保证代码质量。
• 运用 standard - version 实现版本管理自动化，简化版本管理流程。
• 项目结构清晰、易于维护，降低开发和维护成本。

📦 安装指南

从仓库安装

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

bun install

从 npm 安装（发布后）

将以下内容添加到你的 Claude Desktop 配置中：

// 只需要在需要传递参数时包含命令行参数
{
  "mcpServers": {
    "your-server-name": {
      "command": "npx",
      "args": ["-y", "your-package-name", "some_argument"]
    }
  }
}

💻 使用示例

基础用法

创建新工具

该项目提供一个脚本来帮助创建新的 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

将开发的 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"]
    }
  }
}

📚 详细文档

📂 项目结构

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

要将你的开发 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 更新版本号。