Integrations
Allows loading environment variables from a .env file for server configuration, including port, API key, and host settings.
Provides development mode with automatic server restarting for a smoother development experience.
Enables production deployment with process management capabilities for improved stability and monitoring.
MCP boilerplate: Model Context Protocol Server
This server implements the Model Context Protocol (MCP) for global use as a boilerplate. It provides a standardized way to connect AI models to different data sources and tools using the Model Context Protocol.
Features
- Implements the MCP Server-Sent Events (SSE) transport
- Provides a robust structure for building custom MCP servers
- Includes example tools with proper type definitions
- Secure authentication with API key
- Logging capabilities with different severity levels
- Session management for multiple client connections
- Graceful shutdown handling for SIGINT and SIGTERM signals
Tools
The server currently includes the following example tool:
calculator
: Performs basic arithmetic operations (add, subtract, multiply, divide)
For information on how to add your own custom tools, check out the Extending the Boilerplate section.
Configuration
The server configuration is centralized in src/config.ts
. This makes it easy to adjust settings without modifying multiple files.
Troubleshooting SSE Timeouts
If you're experiencing "Body timeout error" with your MCP connection:
- Decrease
keepaliveInterval
to send more frequent keepalive messages (e.g., 15000ms) - Ensure
usePingEvents
is enabled for additional connection stability - Check for any proxy timeouts if you're using a proxy server
Setup
- Install dependencies:
- Create a
.env
file with the following variables:
- Build the project:
- Start the server:
Development
API Endpoints
/health
: Health check endpoint that returns server status and version/sse
: SSE endpoint for establishing MCP connections (requires API key)/messages
: Message handling endpoint for client-server communication
MCP Configuration
To connect an MCP to this server, add the following configuration:
Extending the boilerplate
Adding Custom Tools
Follow these steps to add a new tool to the MCP server:
- Create your tool handler:
- Add your new tool handler in
src/tools.ts
file or create a new file in thesrc/tools
directory - The tool should follow the
ToolHandler
interface
- Add your new tool handler in
- Configure your tool:
- Add your tool configuration to the
toolConfigs
array insrc/tools.ts
- Define the name, description, input schema, and handler for your tool
- Add your tool configuration to the
- Export and register your tool:
- If you created a separate file, export your handler and import it in
src/tools.ts
- Make sure your tool is properly registered in the
toolConfigs
array
- If you created a separate file, export your handler and import it in
Example:
Error Handling
The server implements comprehensive error handling:
- All operations are wrapped in try/catch blocks
- Proper validation for parameters and inputs
- Appropriate error messages for better debugging
- Helper functions for creating standardized error and success responses
Security Considerations
- API key authentication for all connections
- Type validation for all parameters
- No hard-coded sensitive information
- Proper error handling to prevent information leakage
- Session-based transport management
MCP Protocol Features
This boilerplate supports the core MCP features:
- Tools: List and call tools with proper parameter validation
- Logging: Various severity levels (debug, info, notice, warning, error, critical, alert, emergency)
- Server configuration: Name, version, and capabilities
Session Management
The server manages client sessions through:
- Unique session IDs for each client connection
- Tracking of active transports by session ID
- Automatic cleanup of disconnected sessions
- Connection status tracking
Additional Resources
License
This project is licensed under the MIT License - see the LICENSE file for details.
This server cannot be installed
A server that implements the Model Context Protocol, providing a standardized way to connect AI models to different data sources and tools.
Related MCP Servers
- AsecurityFlicenseAqualityA Model Context Protocol server that enables AI models to interact with SourceSync.ai's knowledge management platform for managing documents, ingesting content from various sources, and performing semantic searches.Last updated -2514
- -securityFlicense-qualityA server that enables AI systems to browse, retrieve content from, and interact with web pages through the Model Context Protocol.Last updated -
- AsecurityFlicenseAqualityA Model Context Protocol server implementation that provides structured, AI-friendly access to eRegulations data, making it easier for AI models to answer user questions about administrative procedures.Last updated -428TypeScript
- -securityAlicense-qualityA Model Context Protocol server that provides a standardized interface for AI models to access, query, and modify content in Notion workspaces.Last updated -2752TypeScriptMIT License