MCP TypeScript Server Starter

MCP TypeScript Server Starter

site icon
2025.04.16 1
HTMLMCP服务器TypeScript开发开发效率
sbb-mcp-server 是一个基于 TypeScript 的 Model Context Protocol (MCP) 服务器启动项目,提供了简单的 echo 服务器实现,展示了 MCP 的核心特性。该项目支持工具、资源和提示的创建,适用于本地开发和远程部署场景。
View on GitHub

Overview

基本能力

产品定位

sbb-mcp-server 是一个用于构建 MCP 服务器的 TypeScript 启动项目,旨在简化 MCP 服务器的开发流程。

核心功能

  • 简单的 echo 服务器实现
  • 支持工具、资源和提示的创建
  • TypeScript 支持
  • 开发服务器支持热重载
  • 内置检查器用于测试和调试
  • 支持 STDIO 和 SSE 两种通信模式

适用场景

  • 本地 MCP 服务器开发
  • 远程 MCP 服务器部署
  • 与 Cursor/Claude Desktop 等工具集成
  • 构建自定义 AI 交互工具

工具列表

  1. Echo Tool:简单的回显工具,返回输入消息
  2. Echo Resource:可通过 URI 访问的资源
  3. Echo Prompt:用于处理消息的提示模板

常见问题解答

  1. SSE 模式部署问题:在 Coolify 部署时需要禁用 GZIP 压缩
  2. 端口配置:部署时需要确保端口 3001 正确暴露
  3. 环境变量:建议使用 .env 文件管理敏感信息

使用教程

使用依赖

  • Node.js (v16 或更高版本)
  • pnpm (推荐) 或 npm

安装教程

  1. 克隆仓库:
git clone https://github.com/ralf-boltshauser/mcp-typescript-server-starter.git
cd mcp-typescript-server-starter
  1. 安装依赖:
pnpm install

调试方式

  1. 启动开发服务器:
pnpm dev
  1. 访问检查器:http://localhost:6274
  2. 测试 MCP 服务器:
  3. 在检查器中点击"Connect"
  4. 导航到"Tools"部分
  5. 点击"List Tools"
  6. 选择"echo"工具
  7. 写入测试消息
  8. 点击"Submit"

部署教程

  1. 在 Coolify 上设置:
  2. 连接仓库
  3. 在高级设置中禁用 GZIP 压缩
  4. 配置域名为 https://subdomain.yourdomain.com:3001
  5. 验证部署:
  6. 访问 subdomain.yourdomain.com 查看 index.html
  7. https://subdomain.yourdomain.com/sse 测试 SSE 连接

连接部署服务器

npx -y mcp-remote https://subdomain.yourdomain.com/sse

通信模式

STDIO 模式

  1. 配置服务器:
  2. src/index.ts 中注释掉 Express/SSE 代码
  3. 取消注释 STDIO 代码
  4. 构建并运行:
pnpm build
node dist/index.cjs

pnpm dev

SSE 模式

  1. 配置服务器:
  2. 保持 Express/SSE 代码启用
  3. 注释掉 STDIO 代码
  4. 本地开发:
pnpm dev

服务器将在以下地址可用: - 主端点: http://127.0.0.1:3001 - SSE 端点: http://127.0.0.1:3001/sse - 测试端点: http://127.0.0.1:3001/test - 检查器: http://127.0.0.1:6274

许可证

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