boot-mcp

boot-mcp

一个全面的入门模板，可用于使用 TypeScript 构建 Model Context Protocol（MCP）应用。

什么是 MCP？

Model Context Protocol（MCP）让你能够以安全、标准化的方式构建服务，向大模型应用公开数据和功能。可以把它看作 Web API，但专为大模型交互设计。MCP 服务可以：

• 通过资源公开数据（可以把它们看作类似 GET 端点；用于将信息加载到大模型的上下文中）
• 通过工具提供功能（类似 POST 端点；用于执行代码或以其他方式产生副作用）
• 通过提示词定义交互模式（用于大模型交互的可重用模板）
• 通过根目录设定边界（定义服务的操作范围）
• 通过采样启用 Agent 行为（允许服务向大模型请求补全内容）
• 通过传输方式建立连接（客户端与服务之间的通信机制）

安装

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

快速开始

此模板包含使用不同传输方式的 MCP 服务示例：

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

运行示例服务

# Start the stdio server
pnpm start:basic

# Start the HTTP server
pnpm start:http

项目结构

boot-mcp/
├── src/
│   ├── index.ts          # Main entry point
│   ├── server/           # MCP server implementations
│   │   ├── basic.ts      # Basic server with common functionality
│   │   └── http.ts       # HTTP with SSE transport server
│   ├── resources/        # Resource implementations
│   │   └── index.ts      # Common resource types and utilities
│   ├── tools/            # Tool implementations
│   │   └── index.ts      # Various tools organized by category
│   ├── prompts/          # Prompt implementations
│   │   └── index.ts      # Common prompt templates and workflows
│   ├── roots/            # Root management
│   │   └── index.ts      # Root definition and utilities
│   ├── transports/       # Transport implementations
│   │   └── index.ts      # Stdio and HTTP/SSE transports
│   └── sampling/         # Sampling utilities (experimental)
│       └── index.ts      # LLM sampling capabilities
├── examples/             # Example usage
│   ├── basic-server.ts   # Basic stdio server example
│   └── http-server.ts    # HTTP server example
└── test/                 # Tests

功能

资源

• 支持文本和二进制资源
• 带参数的动态资源模板
• 标准资源类型（文件、系统信息等）
• 资源内容辅助工具

工具

• 系统操作工具（执行命令、读取文件等）
• 数据处理工具（JSON 解析、CSV 分析等）
• 实用工具（随机生成器、字符串转换等）
• 计算器和基础工具

提示词

• 简单的问候和文本处理提示词
• 带语言检测的代码审查提示词
• 多步调试工作流
• 基于资源的提示词模板

根目录

• 文件系统根目录管理
• URI 验证和筛选
• 标准根目录模板

传输方式

• 面向终端应用的 Stdio 传输
• 面向 Web 应用的 HTTP/SSE 传输
• 统一配置接口

采样（实验性）

• 文本补全请求
• 基于对话的采样
• 模型偏好控制
• Agent 工作流示例

许可证

MIT 许可证 © Kirk Lin