Integrations
Integrated with Cloudflare for deployment and hosting of the MCP server, with a 'Deploy to Cloudflare' button for easy setup
Built on Cloudflare Workers for edge computing capabilities, allowing the MCP server to run as a serverless function with Durable Objects for stateful connections
Provides community support through a Discord server with a dedicated #mcp channel for feature requests, support, and discussions
Xava Labs Typescript MCP Template
A template repository for bootstrapping MCPs (Model Context Protocol) for the xava-labs/typescript-agent-framework.
Getting Started
Setup the repository
Option A: Use this template
- Click the "Use this template" button at the top of this repository
- Clone your new repository
Option B: Use deploy to cloudflare button
The following button will create a new repo in your organization and setup teh CI/CD using Cloudflare:
NOTE: The configuration only needs npm run deploy
for the Deploy command to work
Option C: Use cloudflare create
You can create a new project based on this template using wrangler:
- Copy the following text for ease
xava-labs/mcp-template
- Run the following command, follow interactive prompt by choosing name, then start with "Template from GitHub repo" and then paste the above text for the template you want to use.
Once you have completed one of the above methods, then run the following commands in your terminal to get started:
The above will boostrap a serverless cloudflare compatible MCP Server with the following urls:
- /ws - Websocket connection endpoint
- /sse - SSE connection endpoint
Features
- WebSocket Client Support: Includes official WebSocket client for real-time bidirectional communication
- SSE Client Support: Includes Server-Sent Events client for server-to-client streaming
- MCP Inspector: Debug and monitor your MCP during development
- Cloudflare Workers Integration: Built on Cloudflare Workers for edge computing capabilities
- Integration Testing Suite: Websocket and SSE testing tools to do full integration testing with local miniflare services (D1/KV/etc) for ease of testing features without mocking.
Available Scripts
npm run dev
: Runs both the MCP Inspector (port 6274) and Cloudflare Worker (port 8787) concurrentlynpm start
: Runs only the Cloudflare Worker (port 8787)npm test
: Runs tests with Vitestnpm run deploy
: Deploys your MCP to Cloudflare Workersnpm run cf-typegen
: Generates TypeScript types for Cloudflare Workers (run this everytime you add new changes to wrangler.jsonc)
Development
This template implements an MCP server using Durable Objects for stateful connections. The base project structure offers two main approaches for extending functionality:
McpHonoServerDO Implementation
By default, the template uses McpHonoServerDO
which combines the MCP server with Hono, a fast and lightweight web framework. This provides a clean routing system and middleware capabilities.
Extending with Tools, Resources, and Prompts
The main server implementation is in src/server.ts
and extends McpHonoServerDO
:
To add functionality, use the following modules:
- Tools (
src/tools.ts
): Define functions that clients can call
- Resources (
src/resources.ts
): Define persistent resources clients can access
- Prompts (
src/prompts.ts
): Define prompt templates
Customizing Routes with Hono
To add custom HTTP endpoints with McpHonoServerDO
, extend the setupRoutes
method:
McpServerDO Implementation (Native Cloudflare Routing)
If you need more control over the HTTP request handling, you can directly extend McpServerDO
instead. This gives you full control over the fetch
method:
This approach is useful when you need to:
- Handle specific routes with custom logic
- Implement complex middleware or authentication
- Intercept or modify requests before they reach the MCP handler
- Add custom WebSocket or SSE endpoints beyond the standard MCP implementation
Examples
CRUD Todo List Example
For a complete working example, check out the CRUD Todo List MCP Example which demonstrates:
- Full CRUD operations using MCP tools
- SQLite database integration for persistence
- Real-time updates via WebSocket/SSE
- Comprehensive error handling
- Advanced filtering and sorting capabilities
- Rich prompts and resources
Related Resources
Core Packages
- MCP Package: The core MCP implementation with advanced features and testing utilities
- TypeScript Agent Framework: Build intelligent agents powered by LLMs with the Agent Framework
Documentation
- Documentation: Coming soon!
Community
Join our community to get help, share ideas, and contribute to the project:
- Discord: Join the
#mcp
channel for feature requests, support, and discussions
Contributing
We welcome contributions to improve this template! Here's how you can contribute:
- Fork the repository: Create a fork to make your changes
- Create a branch: Make your changes in a new branchCopy
- Commit your changes: Make meaningful commitsCopy
- Push to your fork: Push your changes to your forkCopy
- Create a pull request: Open a PR with a detailed description of your changes
Pull Request Guidelines
- Provide a clear, descriptive title for your PR
- Include a detailed description of what your PR does
- Reference any related issues
- Include screenshots or examples if applicable
- Ensure all tests pass
- Keep PRs focused on a single feature or fix
For larger changes or features, we recommend discussing them first in our Discord channel to ensure alignment with the project direction.
Or use the Deploy to Cloudflare button above to deploy directly from GitHub.
License
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
A template repository for bootstrapping Model Context Protocol (MCP) servers with WebSocket and SSE support, enabling real-time bidirectional communication and server-to-client streaming in Cloudflare Workers.
Related MCP Servers
- -securityFlicense-qualityA Cloudflare Workers-based implementation of the Model Context Protocol server with OAuth login, allowing Claude and other MCP clients to connect to remote tools.Last updated -TypeScript
- AsecurityFlicenseAqualityAn implementation of the Model Context Protocol (MCP) server using Server-Sent Events (SSE) for real-time communication, providing tools for calculations and dynamic resource templates.Last updated -1JavaScript
- -securityFlicense-qualityA server for hosting Model Context Protocol (MCP) tools on Cloudflare Workers with OAuth authentication, allowing Claude AI and other MCP clients to access extended capabilities.Last updated -TypeScript
- -securityFlicense-qualityA remote MCP server implementation for Cloudflare that uses server-sent events (SSE) to enable Model Control Protocol communication.Last updated -TypeScript