MCP Server Starter

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Integrates with Biome for linting and formatting of the MCP server codebase.

  • Uses Bun for fast testing and development of the MCP server.

  • Supports publishing the MCP server as an npm package for easy distribution and installation.

MCP 服务器启动器

使用 TypeScript 构建模型上下文协议 (MCP) 服务器的生产就绪入门模板。

🚀 快速入门

  1. 克隆存储库
  2. 安装依赖项:
    bun install

✨ 主要特点

  • 用于快速测试和开发的 Bun
  • Biome 用于 linting 和格式化
  • 使用标准版本进行自动化版本管理
  • 干净、可维护的项目结构

📂 项目结构

mcp-starter/ ├── src/ │ ├── tools/ # MCP tools implementation │ ├── utils/ # Shared utilities │ ├── main.ts # Server entry point │ └── types.ts # Shared type definitions ├── tests/ # Test files ├── biome.json # Linting configuration ├── tsconfig.json # TypeScript configuration └── package.json # Project dependencies

⚙️ 配置

创建新工具

该项目包括一个帮助创建新 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
  • Lint 代码bun run lint
  • 构建项目bun run build

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

  1. 构建项目:
    bun run build
  2. 添加到您的 Claude 桌面配置:
    // You only need the argument if you need to pass arguments to your server { "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 桌面配置:

// You only need the argument if you need to pass arguments to your server { "mcpServers": { "your-server-name": { "command": "npx", "args": ["-y", "your-package-name", "some_argument"] } } }

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

一个可用于生产的模板,用于使用 TypeScript 创建模型上下文协议服务器,提供高效测试、开发和部署的工具。

  1. 🚀 Quick Start
    1. ✨ Key Features
      1. 📂 Project Structure
        1. ⚙️ Configuration
          1. Creating New Tools
        2. 🛠️ Development
          1. 📜 Version Management
            1. Commit Message Format
          2. 📦 Publishing to npm
            1. Installing from npm (after publishing)
              ID: n087wjbtlk