MCP TypeScript Starter

MCP TypeScript Starter

site icon
2025.04.30 0
TypeScript开发模板快速启动开发效率
MCP TypeScript Starter 是一个基于 TypeScript 的 MCP 服务器实现,灵感来源于 Go 版本。它提供了一个简单的开发起点,包含基本的工具和资源管理功能。
View on GitHub

Overview

基本能力

产品定位

MCP TypeScript Starter 是一个开发效率工具,旨在为开发者提供一个快速启动 MCP 服务器项目的模板。

核心功能

  • 工具:提供 hello 工具,用于向某人打招呼(使用 MCP_GREETING 环境变量自定义问候语)。
  • 资源:提供 example://md 资源,用于服务 src/resources/example.md 文件中的 Markdown 内容。
  • 提示:提供 greeting-prompt 提示,用于按名称问候用户。

适用场景

  • 快速启动一个基于 TypeScript 的 MCP 服务器项目。
  • 学习和理解 MCP 服务器的基本结构和功能。
  • 开发简单的工具和资源管理功能。

工具列表

  • hello:向某人打招呼,使用 MCP_GREETING 环境变量自定义问候语。
  • example://md:服务 Markdown 文件内容。
  • greeting-prompt:按名称问候用户的提示。

常见问题解答

使用教程

使用依赖

  • 需要安装 Node.js 和 npm。

安装教程

npm install

运行服务器

# 开发模式运行(使用 ts-node)
npm run dev

# 或使用脚本
./script/ts-run

# 构建并运行编译后的版本
npm run build
npm start

调试方式

  • 设置 MCP_GREETING 环境变量以自定义 hello 工具的问候语。
  • 使用开发模式运行服务器以实时查看更改。

许可证

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