使用说明

项目简介

create-mcp-app 是一个命令行工具，旨在帮助开发者快速创建基于 Model Context Protocol (MCP) 的服务器应用程序。它提供预配置的项目模板，包含了 MCP 服务器的基本框架和示例代码，让开发者可以专注于实现核心的上下文服务逻辑，而无需从零开始搭建项目。

主要功能点

快速搭建 MCP 服务器: 通过简单的命令行指令，即可生成一个可运行的 MCP 服务器项目。
内置 TypeScript 支持: 项目模板使用 TypeScript 构建，提供更好的代码可维护性和开发体验。
现代开发工具链: 集成了 ESLint, TypeScript, tsup 等现代开发工具，提升开发效率和代码质量。
结构清晰的项目模板: 生成的项目结构清晰，模块化设计，易于扩展和定制，包含资源、工具处理器的示例代码。
支持多种服务器类型: 提供高阶和进阶两种服务器类型模板，满足不同复杂度的应用需求。

安装步骤

确保 Node.js 环境: 确保你的电脑上已安装 Node.js (>= 18.17.0) 和 npm, pnpm, yarn 或 bun 其中之一的包管理器。

全局安装 create-mcp-server-app: 在命令行终端中运行以下命令进行全局安装（推荐使用 npm 或 pnpm）：

npm install -g create-mcp-server-app
# 或
pnpm install -g create-mcp-server-app

创建 MCP 服务器应用: 使用以下命令创建新的 MCP 服务器应用，将 'my-mcp-server' 替换为你想要的项目名称：

create-mcp-server-app my-mcp-server
# 或使用 npx (无需全局安装):
npx create-mcp-server-app my-mcp-server

你也可以在创建项目时选择服务器类型 (high-level 或 advanced)，例如：

npx create-mcp-server-app --serverType advanced my-mcp-server

根据提示选择所需的配置项，或者直接使用默认配置快速创建。

服务器配置

MCP 服务器是为 MCP 客户端提供服务的后端应用。MCP 客户端需要配置服务器的启动信息才能连接和使用服务器的功能。以下是一个 MCP 客户端可能的服务器配置示例 (JSON 格式)，你需要根据实际情况进行配置：

{
  "servers": [
    {
      "name": "my-mcp-server",  // MCP 服务器的名称，客户端用于标识和管理连接
      "command": "node",       // 启动 MCP 服务器的命令，这里假设使用 Node.js 运行
      "args": [                // 启动命令的参数
        "dist/index.js"      //  指向编译后的服务器入口文件。根据项目 'tsup.config.ts' 配置，编译输出目录为 'dist'，入口文件为 'src/index.ts' 编译后的 'index.js'
      ],
      "transport": "stdio"     //  指定传输协议，这里使用标准输入输出 (stdio)
    }
  ]
}

配置参数注释:

'name': 服务器名称，客户端自定义，用于区分不同的 MCP 服务器连接。
'command': 启动服务器进程的可执行命令。对于 Node.js 服务器，通常是 'node'。
'args': 传递给 'command' 的参数数组。对于脚手架生成的项目，编译后入口文件路径通常是 'dist/index.js'。
'transport': MCP 客户端与服务器通信的传输协议。'stdio' 表示使用标准输入输出进行通信，这是脚手架默认配置。

注意: MCP 客户端需要能够执行 'command' 和 'args' 指定的命令来启动 MCP 服务器进程，并建立连接。请确保客户端环境配置正确，能够找到 Node.js 运行时环境以及 'dist/index.js' 文件。

基本使用方法

进入项目目录: 创建成功后，使用 'cd my-mcp-server' 命令进入项目目录。

安装依赖: 如果在创建项目时没有选择自动安装依赖，需要手动安装：

pnpm install  # 或 npm install, yarn install, bun install

启动开发模式: 运行以下命令启动 TypeScript 编译监听和服务器：
```
pnpm watch   # 或 npm run watch, yarn watch, bun watch
```
这会在后台编译 TypeScript 代码，并在代码变更时自动重启服务器。
配置 MCP 客户端: 根据 "服务器配置" 章节的说明，配置你的 MCP 客户端，使其能够连接到本地运行的 MCP 服务器。
开发和扩展: 在 'src' 目录下修改和扩展服务器代码，例如在 'src/server/resources.ts' 或 'src/server/tools.ts' 中添加自定义的资源和工具。

通过以上步骤，你就可以快速搭建并开始开发自己的 MCP 服务器应用了。

关键词