API & MCP Server Skeleton (ElysiaJS + Bun)

API 与 MCP 服务骨架（ElysiaJS + Bun）

（文档尚未完善。）

📑 目录

• API 与 MCP 服务骨架（ElysiaJS + Bun）
  • 🚀 功能
  • 📌 要求
  • 🛠️ 开始使用
  • 🧠 模型上下文协议（MCP）
  • 🔌 WebSocket 用法
  • 📁 项目结构
  • 🚀 部署
  • 🔖 许可证
  • 📘 参考资料
• MCP 与传统 API 的比较

---

一个轻量、高性能的 API 服务，使用 ElysiaJS 和 Bun 运行时，并集成了模型上下文协议（MCP）和 WebSocket 支持。

🚀 功能

• 由 Bun 运行时驱动的 REST API 服务。
• WebSocket 事件处理（实时通信）。
• 支持模型上下文协议（MCP）基础功能：
  • MCP 插件注册表
  • MCP 发现端点（/.well-known/mcp.json）
• 开发期间支持热重载。
• 可用于可扩展部署。
• 示例事件：祈祷时间表、活动注册。

📋 要求

• Bun 运行时（v1.0+）：安装 Bun
• Node.js（可选，用于安装 wscat 等工具）
• WebSocket 客户端（Postman、wscat 等）

🛠️ 开始使用

克隆此项目并安装依赖项：

git clone https://github.com/luridarmawan/mcp-api-server.git
cd mcp-api-server
bun install

运行开发服务器：

bun run dev

在浏览器中打开 http://localhost:3000。

🧠 模型上下文协议（MCP）

MCP 是一种轻量级通信协议，旨在支持与 AI Agent 或应用程序进行上下文感知交互。

• 基础 URL：http://localhost:3000/mcp
• 发现端点：http://localhost:3000/mcp/.well-known/mcp.json

通过 WebSocket 进行 MCP 基本交互的示例：

{
  "event": "prayer:schedule",
  "data": {
    "city": "Jakarta"
  }
}

完整详情请参阅 MCP 与 API 说明。

🔌 WebSocket 用法

你可以通过 WebSocket 与服务交互：

1. 如有需要，安装 wscat：

npm install -g wscat

2. 连接到 WebSocket 服务：

wscat -c ws://localhost:3000

3. 可以发送的示例事件：

事件	载荷示例	说明
prayer:schedule	"Jakarta"	获取某个城市的祈祷时间
registration:new	{ "name": "Alice", "phone": "081122334455", "email": "[email protected]" }	注册新用户

# Install wscat (jika belum ada)
npm install -g wscat

# Connect ke socket server
wscat -c ws://localhost:3000

# Setelah terhubung, kirim event:
>> {"event":"prayer:schedule","data":{"city":"Jakarta"}}
>> {"event":"registration:new","data":{"name":"Alice","phone":"081122334455","email":"[email protected]"}}

📁 项目结构

.
├── constants.ts
├── index.test.ts
├── index.ts
├── modules
│   ├── mcp
│   │   ├── index.ts
│   │   └── types.ts
│   ├── prayer
│   │   ├── index.ts
│   │   └── types.ts
│   └── registration
│       ├── index.ts
│       └── types.ts
├── services
│   └── prayerService.ts
├── sockets
│   └── index.ts
└── utils
    └── http.ts

🚀 部署

构建并运行生产版本：

bun run build
bun start

可部署到 Vercel、Railway、Fly.io 等平台，或任何支持 Bun 的环境。

📄 许可证

本项目基于 Apache 2.0 许可证授权。

📚 参考资料

• 模型上下文协议/MCP
• ElysiaJS 文档
• Bun 文档