🚀 boot-mcp

一个全面的启动模板，用于构建带有 TypeScript 的 Model Context Protocol (MCP) 应用程序。

[![npm 版本][npm-version-src]][npm-version-href] [![npm 下载量][npm-downloads-src]][npm-downloads-href] [![bundle][bundle-src]][bundle-href] [![JSDocs][jsdocs-src]][jsdocs-href] [![许可证][license-src]][license-href] [![javascript 代码风格][code-style-image]][code-style-url]

🚀 快速开始

此模板包括不同传输的 MCP 服务器示例：

• Stdio 传输（用于命令行工具和直接集成）
• 带 SSE 的 HTTP 传输（用于远程服务器）

运行示例服务器

# 启动基本的 stdio 服务器
pnpm start:basic

# 启动 HTTP 服务器
pnpm start:http

✨ 主要特性

资源

• 文本和二进制资源支持
• 带有工具的动态资源
• 标准资源类型（如文本、JSON）
• 工厂函数创建自定义资源
• 上下文中的资源访问

工具

• 带上下文的命令执行工具
• 工具链实现
• 实验室环境配置
• 动态工具加载和卸载

提示

• 用于提示的模板字符串
• 模板扩展支持
• 上下文变量注入
• 提示历史记录
• 回调支持

根

• 上下文根定义
• 标准上下文属性
• 动态上下文扩展
• 父子上下文继承
• 上下文序列管理

传输

• 标准传输实现（如 HTTP）
• 自定义传输开发
• 传输协议标准化
• 传输性能优化
• 传输日志记录和跟踪

采样

• LLM 请求完成
• 带上下文的采样
• 采样结果处理
• 采样策略实现
• 多语言支持

📦 安装指南

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

📚 详细文档

什么是 MCP？

Model Context Protocol (MCP) 让你可以构建服务器，以安全、标准的方式为 LLM 应用程序提供数据和功能。想象一下，它就像 Web API，但专门为 LLM 交互设计。MCP 服务器可以：

• 通过 资源（类似于 GET 端点；它们用于将信息加载到 LLM 的上下文中）暴露数据
• 通过 工具（类似于 POST 端点；它们用于执行代码或产生副作用）提供功能
• 通过 提示（LLM 交互的重用模板）定义交互模式
• 通过 根（定义服务器的操作范围）
• 通过 采样（允许服务器从 LLM 请求完成）启用代理行为
• 通过 传输（客户端和服务器之间的通信机制）建立连接

项目结构

boot-mcp/
├── src/
│   ├── index.ts          # 主入口点
│   ├── server/           # MCP 服务器实现
│   │   ├── basic.ts      # 带有通用功能的基本服务器
│   │   └── http.ts       # 带 SSE 的 HTTP 传输服务器
│   ├── resources/        # 资源实现
│   │   └── index.ts      # 各种标准资源类型和工具
│   ├── tools/            # 工具实现
│   │   └── index.ts      # 按类别组织的各种工具
│   ├── prompts/          # 提示实现
│   │   └── index.ts      # 常见提示模板和工作流程
│   ├── roots/            # 根管理
│   │   └── index.ts      # 根定义和工具
│   ├── transports/       # 传输实现
│   │   └── index.ts      # Stdio 和 HTTP/SSE 传输
│   └── sampling/         # 采样实用程序（实验性）
│       └── index.ts      # LLM 采样功能
├── examples/             # 示例用法
│   ├── basic-server.ts   # 基本 stdio 服务器示例
│   └── http-server.ts    # HTTP 服务器示例
└── test/                 # 测试

📄 许可证

MIT License