关键词

MCP服务器创建TypeScript脚手架开发工具包服务器配置

项目简介

'mcp-init' 是一个命令行工具，旨在帮助开发者快速启动和搭建基于 Model Context Protocol (MCP) 的服务器项目。它提供了一个默认的项目模板，包含了MCP服务器的基本结构、示例工具以及必要的构建和开发配置，让开发者可以专注于MCP服务器的核心逻辑开发。

主要功能点

  • 快速搭建MCP服务器: 通过简单的命令，即可生成一个预配置好的MCP服务器项目，省去从零开始搭建环境的繁琐步骤。
  • 默认项目模板: 内置默认模板，包含基本的MCP服务器框架和示例代码，方便用户快速上手和修改。
  • 开发和构建脚本: 预配置了开发 ('npm run dev') 和构建 ('npm run build') 脚本，简化开发流程。
  • MCP客户端配置: 提供 'setup' 脚本 ('npm run setup')，自动配置常见的MCP客户端（如 Cursor, Windsurf, Claude Desktop），方便用户快速连接和测试服务器。
  • 可扩展的模板: 支持使用自定义模板，无论是 npm 包还是本地路径，满足更个性化的项目需求。
  • Eject 功能: 提供 'eject' 功能 ('npm run eject')，允许用户将构建配置和脚本从 'mcp-scripts' 中解耦出来，获得完全的控制权。

安装步骤

  1. 全局安装 'mcp-init': 
    npm install -g mcp-init

服务器配置

MCP客户端需要配置MCP服务器的启动信息才能连接。'mcp-init' 创建的项目默认使用 'npm run dev' 启动开发服务器。以下是配置示例，您需要根据实际项目名称调整 'serverName'：

{
  "your-server-name": {  // "your-server-name" 替换为您的项目名称，例如 "my-mcp-server"
    "command": "path/to/your/project/node_modules/.bin/mcp-scripts", // 指向项目 node_modules 目录中 mcp-scripts 的可执行文件路径
    "args": ["dev"]  // 启动参数，"dev" 表示运行开发服务器，您也可以使用 "build" 构建后指向构建产物
  }
}

请注意：

  • 'command' 字段的路径需要根据您的项目实际安装位置进行调整。通常，在项目根目录下运行 'npm run setup' 会自动完成配置。
  • 上述 JSON 配置需要添加到您的 MCP 客户端的配置文件中，具体位置请参考您使用的 MCP 客户端的文档。

基本使用方法

  1. 创建新的 MCP 服务器项目:

    mcp-init your-mcp-server  # "your-mcp-server" 为您要创建的项目目录名

  2. 进入项目目录:

    cd your-mcp-server

  3. 启动开发服务器:

    npm run dev

    此命令会启动开发服务器并监听文件更改，方便您进行开发和调试。

  4. 构建服务器:

    npm run build

    此命令会构建用于生产环境的服务器代码。

  5. 配置 MCP 客户端:

    npm run setup

    此命令会自动尝试配置 Cursor, Windsurf, Claude Desktop 等客户端，简化配置流程。

Eject 操作 (高级用户)

如果您需要更精细地控制构建过程，可以运行 eject 命令：

npm run eject

Eject 命令会将 'mcp-scripts' 的配置和依赖项复制到您的项目，并将 'package.json' 中的脚本修改为直接调用这些配置。 eject 操作是单向的，执行后您需要自行维护构建配置。

信息

分类

开发者工具

访问项目