API & MCP Server Skeleton (ElysiaJS + Bun)

What is API & MCP Server Skeleton (ElysiaJS + Bun)?

A lightweight, high-performance API server built with ElysiaJS on the Bun runtime. It integrates Model Context Protocol (MCP) for context-aware AI interactions and includes WebSocket support for real-time communication. Designed for developers who need a fast, scalable server with MCP and WebSocket capabilities.

How to use API & MCP Server Skeleton (ElysiaJS + Bun)?

Clone the repository, install dependencies with bun install, and start the development server with bun run dev. Access the base API at http://localhost:3000. For WebSocket interactions, connect using a client like wscat to ws://localhost:3000 and send JSON events (e.g., prayer:schedule). For MCP discovery, use the endpoint http://localhost:3000/mcp/.well-known/mcp.json. Build for production with bun run build and start with bun start.

Key features of API & MCP Server Skeleton (ElysiaJS + Bun)

• REST API server powered by Bun runtime.
• WebSocket event handling for real-time communication.
• Model Context Protocol (MCP) support with plugin registry and discovery endpoint.
• Hot reload during development.
• Scalable deployment ready.
• Example events: Prayer Schedule and Event Registration.

Use cases of API & MCP Server Skeleton (ElysiaJS + Bun)

• Build a lightweight API that serves as a context provider for AI agents.
• Create a real-time event system (e.g., prayer schedules, user registrations) via WebSocket.
• Prototype and deploy an MCP-compatible server quickly using Bun and ElysiaJS.
• Serve as a skeleton for integrating MCP into existing Bun-based applications.

FAQ from API & MCP Server Skeleton (ElysiaJS + Bun)

What is MCP and how does this server support it?

MCP (Model Context Protocol) is a lightweight communication protocol for context-aware interactions with AI agents or applications. This server includes an MCP plugin registry and a discovery endpoint at /.well-known/mcp.json.

What are the runtime requirements?

Bun runtime v1.0+ is required. Node.js is optional for installing tools like wscat. A WebSocket client (Postman, wscat, etc.) is needed for WebSocket interactions.

What events are available by default?

Two example events are included: prayer:schedule (get prayer times for a city) and registration:new (register a new user with name, phone, and email).

How can I deploy this server to production?

Build the project with bun run build and start the production server with bun start. It can be deployed on platforms like Vercel, Railway, Fly.io, or any Bun-supported environment.

Is the documentation complete?

No, the documentation is not yet complete. Refer to the README and the separate MCP_and_API.md file for additional details.