使用说明

项目简介

'create-mcp-server-app' 是一个命令行工具，旨在帮助开发者快速搭建基于 Model Context Protocol (MCP) 的服务器应用程序。它提供了一个结构清晰的项目模板，内置 TypeScript 支持，并集成了现代开发工具，让 MCP 服务器的开发变得简单高效。

主要功能点

• 快速搭建MCP服务器应用: 通过简单的命令行指令，即可生成一个预配置好的 MCP 服务器项目框架。
• 内置TypeScript支持: 项目模板默认使用 TypeScript，提供更好的开发体验和代码质量。
• 结构化的项目模板: 生成的项目结构清晰，包含资源 (resources)、工具 (tools)、Prompt 模板 (prompts) 等模块，方便开发者组织和扩展功能。
• 易于扩展和定制: 项目模板设计灵活，开发者可以根据自身需求轻松扩展和定制服务器功能。
• 支持高阶和进阶服务器类型: 提供不同复杂度的服务器模板，满足不同场景的需求。

安装步骤

1. 确保已安装 Node.js (>= 18.17.0) 和 npm, pnpm, 或 yarn。

2. 使用以下命令全局安装 'create-mcp-server-app' (推荐使用 npx，无需全局安装):

   npx create-mcp-server-app my-mcp-server
   

   或使用 pnpm:

   pnpm create mcp-server-app my-mcp-server
   

   或使用 yarn:

   yarn create mcp-server-app my-mcp-server
   

   将 'my-mcp-server' 替换为你希望的项目名称。

3. 根据提示选择服务器类型和是否初始化 Git 仓库、安装依赖等选项。

服务器配置

生成的 MCP 服务器项目可以作为 MCP 客户端的后端服务。MCP 客户端需要配置服务器的启动命令才能连接。以下是针对不同运行环境的 MCP 服务器配置示例 (JSON 格式):

开发环境 (使用 'pnpm dev' 启动开发服务器):

{
  "serverName": "my-mcp-server",
  "command": "pnpm",
  "args": ["dev"]
}

• 'serverName': 服务器名称，通常与 'package.json' 中的 'name' 字段一致。
• 'command': 启动服务器的命令，这里使用 'pnpm'。
• 'args': 传递给命令的参数，'dev' 是项目模板中预设的开发启动脚本。

生产环境 (先使用 'pnpm build' 构建，然后运行 'node dist/index.js'):

{
  "serverName": "my-mcp-server",
  "command": "node",
  "args": ["dist/index.js"]
}

• 'serverName': 服务器名称，同开发环境。
• 'command': 启动服务器的命令，这里使用 'node'。
• 'args': 传递给命令的参数，'dist/index.js' 是构建后的服务器入口文件。

基本使用方法

1. 进入项目目录: 'cd my-mcp-server'
2. 启动开发服务器: 'pnpm dev' (或 'npm run dev', 'yarn dev')
3. 修改服务器代码: 在 'src' 目录下，可以编辑 'index.ts' (或 'main.ts'，取决于选择的服务器类型) 文件来定义资源、工具和 Prompt 模板，扩展服务器功能。
4. 构建生产版本: 'pnpm build' (或 'npm run build', 'yarn build')
5. 运行生产版本: 'node dist/index.js'
6. MCP 客户端连接: 配置 MCP 客户端连接到启动的服务器，即可开始进行基于 MCP 协议的交互。