index.mdβ’20.3 kB
!!! warning "Project Moved to MCP Platform"
## π This project has evolved into **[MCP Platform](https://github.com/Data-Everything/MCP-Platform)**
**What's new:**
- Enhanced architecture and performance
- Better naming that reflects the platform's capabilities
- Expanded template library and deployment options
- Improved documentation and developer experience
**Migration is simple:**
```bash
pip uninstall mcp-templates && pip install mcp-platform
# Replace 'mcpt' with 'mcpp' in your commands
```
**π [Complete Migration Guide](https://data-everything.github.io/MCP-Platform/migration/)** | **π [New Documentation](https://data-everything.github.io/MCP-Platform/)**
# MCP Server Templates (Legacy Documentation)
!!! note "Legacy Version"
This documentation covers the legacy `mcp-templates` package. For the latest features and updates, please visit **[MCP Platform](https://github.com/Data-Everything/MCP-Platform)**.
**Production-ready Model Context Protocol (MCP) server templates for instant, zero-configuration deployment.**
MCP Server Templates is a mature, open-source platform for deploying, managing, and scaling MCP servers with ease. Designed for developers and teams who want to focus on AI integrationβnot infrastructure headaches. Get started in minutes with Docker-powered deployments, a powerful CLI, and flexible configuration options.
Ready to dive in? Start with our [Getting Started Guide](getting-started/quickstart.md).
[](https://pypi.org/project/mcp-templates/)
[](/LICENSE)
[](https://discord.gg/55Cfxe9gnr)
> **Production-ready Model Context Protocol (MCP) server templates with zero-configuration deployment**
Deploy, manage, and scale MCP servers instantly with Docker containers, comprehensive CLI tools, and flexible configuration options.
## π¬ Community
Join our [Discord Community](https://discord.gg/55Cfxe9gnr) for support, discussions, and updates!
## π Quick Navigation
<div class="grid cards" markdown>
- β‘ **[Getting Started](getting-started/installation.md)**
Install MCP Templates and deploy your first server in under 2 minutes
- π» **[CLI Reference](cli/index.md)**
Complete command reference for the `mcp-template` CLI tool
- π¦ **[Server Templates](templates/index.md)**
Browse available templates with advanced configuration properties and deployment options
- π **[Template.json Reference](templates/template-json-reference.md)**
Complete guide to template configuration including volume_mount, command_arg, and transport options
- π οΈ **[Creating Templates](templates/creating.md)**
Step-by-step guide to creating custom MCP templates with best practices
- π **[User Guide](user-guide/)**
In-depth guides for configuration, deployment, and management
</div>
## β‘ What is MCP Templates?
MCP Server Templates is a **self-hosted deployment system** that enables rapid deployment, management, and scaling of Model Context Protocol servers on your own infrastructure.
### Key Benefits
| Traditional MCP Setup | With MCP Templates |
|----------------------|-------------------|
| β Complex server configuration | β
One-command deployment |
| β Docker knowledge required | β
Zero configuration needed |
| β Manual tool discovery | β
Automatic tool detection |
| β Environment setup headaches | β
Pre-built, tested containers |
| β No deployment management | β
Full lifecycle management |
### Core Features
- **π§ Zero Configuration**: Deploy MCP servers with sensible defaults
- **π³ Docker-Based**: Containerized deployments for consistency and security
- **π οΈ Tool Discovery**: Automatic detection of available tools and capabilities
- **π± Interactive CLI**: Streamlined command-line interface for all operations
- **π Lifecycle Management**: Deploy, configure, monitor, and cleanup with ease
- **π― Multiple Templates**: Pre-built servers for GitHub, Zendesk, GitLab, and more
## π Available Templates
| Template | Description | Status |
|----------|-------------|--------|
| **demo** | Simple demonstration server | β
Available |
| **github** | GitHub repository management | β
Available |
| **gitlab** | GitLab integration server | β
Available |
| **zendesk** | Customer support integration | π§ In Progress |
| **filesystem** | Secure file operations server | β
Available |
| **postgres** | PostgreSQL database integration | π§ In Progress |
| **slack** | Slack bot integration | π§ In Progress |
and many more in flight β
## οΏ½ Whatβs Inside
Welcome to the MCP Platformβwhere server deployment meets pure excitement! Hereβs what makes this project a must-have for every AI builder:
### β‘ Features (Mid-August 2025 Release)
#### π Current Features
- **π±οΈ One-Click Docker Deployment**: Launch MCP servers instantly with pre-built templatesβno hassle, just pure speed.
- **π Smart Tool Discovery**: Automatically finds and showcases every tool your server can offer. No more guesswork!
- **π» Slick CLI Management**: Command-line magic for easy, powerful control over all deployments.
- **π€ Bring Your Own MCP Server**: Plug in your own MCP server and run it on our networkβeven with limited features!
- **π³ Effortless Docker Image Integration**: Add any existing MCP Docker image to the templates library with minimal setup and unlock all the platformβs cool benefits.
- **β‘ Boilerplate Template Generator**: Instantly create new MCP server projects with a CLI-powered generatorβkickstart your next big idea!
- **π οΈ Multiple Ways to Set Configuration**: Flex your setup with config via JSON, YAML, environment variables, CLI config, or CLI override optionsβtotal flexibility for every workflow!
#### π Planned Features
- **π¦Έ MCP Sidekick (Coming Soon)**: Your friendly AI companion, making every MCP server compatible with any AI tool or framework.
Ready to dive in? Check out our [Getting Started Guide](getting-started/quickstart.md)!
## οΏ½π MCP Platform - Managed Cloud Solution
Looking for enterprise deployment without infrastructure management? **[MCP Platform](https://mcp-platform.dataeverything.ai/)** offers:
- β¨ **One-click deployment** - Deploy any MCP server template instantly
- π‘οΈ **Enterprise security** - SOC2, GDPR compliance with advanced security controls
- π **Real-time monitoring** - Performance metrics, usage analytics, and health dashboards
- π§ **Custom development** - We build proprietary MCP servers for your specific needs
- πΌ **Commercial support** - 24/7 enterprise support with SLA guarantees
- π― **Auto-scaling** - Dynamic resource allocation based on demand
- π **Team management** - Multi-user access controls and audit logging
**Ready for production?** [Get started with MCP Platform β](https://mcp-platform.dataeverything.ai/)
---
## Open Source Self-Hosted Deployment
This repository provides comprehensive tools for self-managing MCP server deployments on your own infrastructure.
### π Key Features
- **π― Zero Configuration Deployment** - Deploy templates with a single command
- **π Advanced Tool Discovery** - Automatic detection of MCP server capabilities using official MCP protocol
- **π¦ Pre-built Templates** - Production-ready templates for file operations, databases, APIs, and more
- **π§ Flexible Configuration** - Multi-source configuration with environment variables, CLI options, and files
- **π³ Docker-First Architecture** - Container-based deployments with proper lifecycle management
- **π Rich CLI Interface** - Beautiful command-line interface with comprehensive help and examples
- **π§ͺ Template Development Tools** - Complete toolkit for creating and testing custom templates
- **π Monitoring & Management** - Real-time status monitoring, log streaming, and health checks
- **π Integration Examples** - Ready-to-use code for Claude Desktop, VS Code, Python, and more
### π― Quick Start
#### Installation
```bash
# Install from PyPI (recommended)
pip install mcp-templates
# Verify installation
mcpt --version
```
#### Deploy Your First Template
```bash
# List available templates
mcpt list
# Deploy demo server
mcpt deploy demo
# Discover available tools
mcpt> tools demo
# Get integration examples
mcpt connect demo --llm claude
```
#### Integration with Claude Desktop
```bash
# Get container name
mcpt list
# Update Claude Desktop config
mcpt connect demo --llm claude
```
**Claude Desktop Configuration:**
```json
{
"mcpServers": {
"demo": {
"command": "docker",
"args": ["exec", "-i", "CONTAINER_NAME", "python", "-m", "src.server"]
}
}
}
```
### π Documentation
#### π Getting Started
- **[Installation Guide](getting-started/installation.md)** - Setup and initial configuration
- **[Quick Start Tutorial](getting-started/quickstart.md)** - Deploy your first MCP server
- **[Configuration](getting-started/configuration.md)** - Understanding templates, deployments, and tools
#### π User Guide
- **[CLI Reference](user-guide/cli-reference.md)** - Complete command reference
- **[Monitoring](user-guide/monitoring.md)** - Monitor your deployments
- **[Stdio Tool Execution](stdio-tool-execution.md)** - Interactive tool execution for stdio MCP servers
- **[Monitoring & Management](user-guide/monitoring.md)** - Production deployment management
#### π οΈ CLI Reference
- **[Command Overview](cli/index.md)** - Complete CLI documentation
- **[deploy](cli/deploy.md)** - Deploy HTTP transport templates with configuration options
- **[run-tool](stdio-tool-execution.md#basic-usage)** - Execute tools from stdio MCP servers
- ~~**[tools](cli/tools.md)**~~ - **DEPRECATED**: Use interactive CLI instead
- ~~**[discover-tools](cli/discover-tools.md)**~~ - **DEPRECATED**: Use interactive CLI instead
- **[connect](cli/connect.md)** - Generate integration examples for LLMs
- **[config](cli/config.md)** - View template configuration options
- **[list](cli/list.md)** - List templates and deployments
- **[logs](cli/logs.md)** - Monitor deployment logs
- **[interactive](cli/interactive.md)** - Interactive CLI for deployment management
#### π§ Development
- **[Creating Templates](guides/creating-templates.md)** - Build custom MCP server templates
- **[Template Development](templates/creating.md)** - Advanced template development
- **[Tool Discovery System](tool-discovery.md)** - Understanding tool discovery architecture
- **[Testing & Validation](guides/testing.md)** - Test templates and deployments
- **[Contributing](guides/contributing.md)** - Contribute to the project
#### ποΈ System Architecture
- **[Architecture Overview](development/architecture.md)** - System design and components
- **[Development Setup](development/setup.md)** - Setting up development environment
- **[API Reference](api/)** - Complete API documentation
### π― Use Cases
#### File Operations
```bash
# Deploy secure file server
mcpt deploy filesystem \
--config security__allowed_dirs='["/data", "/workspace"]' \
--config security__read_only=false
# Connect to Claude Desktop for file operations
mcpt connect filesystem --llm claude
```
#### Database Integration
```bash
# Deploy PostgreSQL MCP server
mcpt deploy postgres-server \
--config database__host=localhost \
--config database__name=mydb \
--env POSTGRES_PASSWORD=secret
# Generate Python integration code
mcpt connect postgres-server --llm python
```
#### API Integration
```bash
# Deploy REST API integration server
mcpt deploy api-server \
--config api__base_url=https://api.example.com \
--config api__auth_token=$API_TOKEN
# Test with cURL
mcpt connect api-server --llm curl
```
### π Tool Discovery
**Automatic MCP Protocol Discovery:**
```bash
# Discover tools from any MCP-compliant Docker image
mcpt> tools--image mcp/filesystem /tmp
# Rich formatted output shows all capabilities:
β
Discovered 11 tools via docker_mcp_stdio
- read_file: Read complete file contents
- write_file: Create or overwrite files
- list_directory: List directory contents
- create_directory: Create directories
- ... and 7 more tools
```
**Integration Ready:**
```bash
# Get ready-to-use integration code
mcpt i
mcpt> tools demo --format json
exit
mcpt> connect demo --llm vscode
```
### π Available Templates
| Template | Description | Use Cases |
|----------|-------------|-----------|
| **demo** | Basic greeting and echo server | Learning, testing, examples |
| **filesystem** | Secure filesystem operations | Document processing, file management |
| **postgres-server** | PostgreSQL database integration | Data analysis, query execution |
| **api-server** | REST API client with auth | External service integration |
| **mongodb-server** | MongoDB document operations | NoSQL data operations |
| **redis-server** | Redis cache and pub/sub | Caching, real-time messaging |
### π οΈ System Requirements
- **Operating System**: Linux, macOS, Windows (with WSL2)
- **Docker**: Version 20.10+ (required for container deployments)
- **Python**: Version 3.9+ (for CLI and development)
- **Memory**: 512MB minimum, 2GB recommended
- **Storage**: 1GB minimum for templates and container images
### π¦ Production Deployment
#### Security Considerations
```bash
# Deploy with security hardening
mcpt deploy filesystem \
--config security__read_only=true \
--config security__max_file_size=10 \
--config logging__enable_audit=true \
--env MCP_ALLOWED_DIRS='["/secure/data"]'
```
#### Monitoring Setup
```bash
# Health check monitoring
mcpt list --format json | jq '.summary'
# Log monitoring
mcpt logs filesystem --follow --since 1h
```
#### Backup and Recovery
```bash
# Export deployment configuration
mcpt status filesystem --format json > backup.json
# Cleanup and redeploy
mcpt cleanup filesystem
mcpt deploy filesystem --config-file backup.json
```
### π€ Community & Support
- **π Documentation**: Comprehensive guides and API reference
- **π Issue Tracker**: [GitHub Issues](https://github.com/Data-Everything/mcp-server-templates/issues)
- **π¬ Discussions**: [GitHub Discussions](https://github.com/Data-Everything/mcp-server-templates/discussions)
- **οΏ½ Community Slack**: [Join mcp-platform workspace](https://join.slack.com/t/mcp-platform/shared_invite/zt-39z1p559j-8aWEML~IsSPwFFgr7anHRA)
- **οΏ½π§ Enterprise Support**: [Contact us](mailto:support@dataeverything.ai) for commercial support
### πΊοΈ Roadmap
- **Kubernetes Backend**: Native Kubernetes deployment support
- **Template Marketplace**: Community-driven template sharing
- **GraphQL Integration**: GraphQL API server templates
- **Metrics & Alerting**: Prometheus/Grafana integration
- **Multi-tenant Support**: Isolated deployments for teams
- **Auto-scaling**: Dynamic resource allocation
### π License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
**Get started today**: Choose between our [managed cloud platform](https://mcp-platform.dataeverything.ai/) for instant deployment or [self-hosted deployment](getting-started/installation.md) for full control.
# Install dependencies
pip install -e .
```
#### Basic Usage
```bash
# List available templates
mcpt list
# Deploy a template
mcpt deploy filesystem
# View logs
mcpt logs filesystem
```
#### Show Configuration Options
```bash
# View configuration options for any template
mcpt deploy filesystem --show-config
# Deploy with custom configuration
mcpt deploy filesystem --config read_only_mode=true
# Deploy with config file
mcpt deploy filesystem --config-file config.json
```
## Available Templates
Our templates are automatically discovered and validated using the `TemplateDiscovery` utility to ensure only working implementations are listed. This keeps the documentation up-to-date as new templates are added.
*Use `mcpt list` to see all currently available templates, or visit the [Templates](server-templates/index.md) section for detailed documentation.*
**Popular Templates:**
- **filesystem** - Secure filesystem access for AI assistants
- **demo** - Demonstration server with greeting tools
- **github** - GitHub API integration for repository access
- **database** - Database connectivity for SQL operations
## Architecture
The system uses a simple architecture designed for self-hosted deployments:
```
βββββββββββββββ ββββββββββββββββββββ βββββββββββββββββββββββ
β CLI Tool ββββββ Template ββββββ Docker Backend β
β β β Discovery β β β
β β’ Commands β β β’ Load metadata β β β’ Container deploy β
β β’ Config β β β’ Schema validation β β β’ Volume management β
β β’ Display β β β’ Config mapping β β β’ Health monitoring β
βββββββββββββββ ββββββββββββββββββββ βββββββββββββββββββββββ
```
**Key Components:**
- **CLI Interface** - Rich command-line interface (`mcp-template`)
- **Template Discovery** - Automatic detection and validation of templates
- **Docker Backend** - Container-based deployment with volume management
- **Configuration System** - Multi-source configuration with type conversion
## Configuration System
Templates support flexible configuration from multiple sources:
**Configuration precedence (highest to lowest):**
1. Environment variables (`--env KEY=VALUE`)
2. CLI configuration (`--config KEY=VALUE`)
3. Configuration files (`--config-file config.json`)
4. Template defaults
**Example configuration:**
```bash
# Using CLI options
mcpt deploy filesystem \
--config read_only_mode=true \
--config max_file_size=50 \
--config log_level=debug
# Using environment variables
mcpt deploy filesystem \
--env MCP_READ_ONLY=true \
--env MCP_MAX_FILE_SIZE=50
# Using config file
mcpt deploy filesystem --config-file production.json
```
## Template Development
Create custom MCP server templates:
```bash
# Interactive template creation
mcpt create my-custom-server
# Follow prompts to configure:
# - Template metadata
# - Configuration schema
# - Docker setup
# - Documentation
```
Each template includes:
- `template.json` - Metadata and configuration schema
- `Dockerfile` - Container build instructions
- `README.md` - Template documentation
- `docs/index.md` - Documentation site content
- `src/` - Implementation code
## Documentation
- **[Templates](server-templates/index.md)** - Available templates and their configuration
- **[Getting Started](getting-started/quickstart.md)** - Installation and first deployment
- **[Guides](guides/creating-templates.md)** - Advanced usage and template development
- **[Development](development/architecture.md)** - Technical architecture and development
## Community
- **[GitHub Issues](https://github.com/Data-Everything/mcp-server-templates/issues)** - Bug reports and feature requests
- **[Discussions](https://github.com/Data-Everything/mcp-server-templates/discussions)** - Community questions and sharing
- **Contributing** - See our [contribution guidelines](guides/contributing.md)
## Commercial Services
Need help with custom MCP servers or enterprise deployment?
**[MCP Platform](https://mcp-platform.dataeverything.ai/)** offers:
- Custom MCP server development
- Enterprise hosting and support
- Professional services and consulting
π§ **Contact us:** [tooling@dataeverything.ai](mailto:tooling@dataeverything.ai)
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/Data-Everything/mcp-server-templates/blob/main/LICENSE) file for details.
---
*MCP Server Templates - Deploy AI-connected services on your own infrastructure.*