使用说明
MCP服务器套件
用于构建的TypeScript启动模板 模型上下文协议 (MCP)服务器。提供项目结构、代码生成器和约定,以便您可以专注于构建工具、资源和提示。
特性
- ⚙️ TypeScript首次设置
- 🧩 基于Stdio的MCP服务器
- 🛠 工具、提示和资源生成器
- 🧹 开箱即用的装订、格式化和类型检查
- 📁 清晰、与MCP一致的项目结构
什么是MCP?
模型上下文协议是一个开放标准,使LLM应用程序能够连接到外部数据源和工具。MCP服务器公开了三个原语:
- 工具 -LLM可以执行的操作(例如,查询数据库、调用API)
- 资源 --LLM可以访问的只读数据(例如,数据库模式、配置文件)
- 提示 --带有参数的可重用模板(例如,“为X设计一个表”)
技术栈
| 类别 | 技术 |
|---|---|
| 运行时 | Node.js |
| 语言 | TypeScript(严格模式) |
| 装订和格式化 | 生物特征 |
| 模式验证 | Zod |
| MCP SDK | @modelcontextprotocol/SDK |
入门指南
nvm use # Use the correct Node version
npm install # Install dependencies
npm run build # Build the project
编译后的服务器将在 dist/server.js.
项目结构
src/
├── server.ts # Server entry point
├── lib/ # Shared utilities
├── prompts/ # MCP prompt definitions
├── resources/ # MCP resource definitions
└── tools/ # MCP tool implementations
包括示例
该模板包括演示模式的工作示例:
提示
| 提示 | 描述 |
|---|---|
design-table |
采用数据描述并生成带有示例使用模式的PostgreSQL表设计 |
资源
| 资源 | URI | 描述 |
|---|---|---|
| 架构 | postgres://schema |
返回包含表、列、类型和约束的完整数据库架构 |
| 统计数据 | postgres://stats |
返回数据库统计信息:版本、大小、连接和正常运行时间 |
工具
| 工具 | 说明 |
|---|---|
sql-query-executor |
对PostgreSQL数据库执行SQL查询 |
代码生成器
脚手架新MCP组件:
npm run generate # Show all generator options
npm run generate:prompt # Create a new prompt
npm run generate:resource # Create a new resource
npm run generate:tool # Create a new tool
生成器创建文件并向服务器自动注册。
命令
| 命令 | 描述 |
|---|---|
npm run build |
将TypeScript编译为 dist/ |
npm run lint |
检查是否有掉毛和类型错误 |
npm run lint:fix |
自动修复掉毛问题 |
npm run format |
使用生物特征格式化代码 |
npm run generate |
支架新MCP组件 |
npm run generate:prompt |
构建一个新的提示 |
npm run generate:resource |
构建新资源 |
npm run generate:tool |
脚手架新工具 |
MCP客户端兼容性
一些MCP功能需要特定的客户端支持。截至2026年1月,大多数客户不支持:
- 引出 --从服务器到用户的交互式输入请求
- 采样 --服务器启动LLM完成
检查 MCP客户文件 查看您的客户端支持哪些功能。随着这些功能获得更广泛的支持,此模板中的示例将进行更新,以演示更高级的用例。
许可证
麻省理工学院