MCP TypeScript Template

MCP TypeScript Template

site icon
2025.03.29 1
TypeScriptTypeScript模板MCP服务器开发开发效率
mcp-ts-template 是一个基于 TypeScript 的 Model Context Protocol (MCP) 服务器模板,旨在为开发者提供一个快速构建 MCP 服务器的起点。该模板提供了生产就绪的实用工具、结构良好的代码和示例实现,帮助开发者快速上手并构建功能强大的 MCP 服务器。
View on GitHub

Overview

基本能力

产品定位

mcp-ts-template 是一个用于快速构建 Model Context Protocol (MCP) 服务器的 TypeScript 模板。它提供了丰富的工具和示例,帮助开发者快速实现 MCP 服务器,扩展 AI 系统的能力。

核心功能

  • 实用工具:包括日志记录、错误处理、ID 生成、速率限制和请求上下文管理等可重用工具。
  • 类型安全:使用 TypeScript 提供强类型支持,在编译时捕获错误。
  • 安全性:内置输入验证和清理功能,防止常见漏洞。
  • 错误处理:基于模式的错误分类和标准化报告。
  • 文档:详细的工具和资源文档,包括使用示例和实现细节。
  • 示例实现:提供 Echo Tool 和 Echo Resource 的完整示例,帮助开发者快速上手。

适用场景

  • 开发者需要快速构建 MCP 服务器以扩展 AI 系统的能力。
  • 团队需要一个结构良好、生产就绪的 MCP 服务器模板作为起点。
  • 需要实现自定义工具和资源以支持特定的 AI 交互需求。

工具列表

工具 描述
Echo Tool 格式化并回显消息,支持多种选项。演示了输入验证、错误处理和正确的响应格式化。

常见问题解答

  1. 如何添加新工具?
  2. src/mcp-server/tools/ 下创建新目录,定义逻辑和模式,实现注册函数,并在 server.ts 中注册。

  3. 如何添加新资源?

  4. src/mcp-server/resources/ 下创建新目录,定义逻辑和模式,实现注册函数,并在 server.ts 中注册。

  5. 如何配置环境变量?

  6. 使用配置系统加载环境变量,支持懒加载和验证。

使用教程

使用依赖

安装教程

  1. 克隆仓库: bash git clone https://github.com/cyanheads/mcp-ts-template.git cd mcp-ts-template

  2. 安装依赖: bash npm install

  3. 构建项目: bash npm run build

调试方式

  1. 运行项目: bash npm start

  2. 查看项目结构: bash npm run tree

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。