# egile-mcp-starter

[![PyPI - Version](https://img.shields.io/pypi/v/egile-mcp-starter.svg)](https://pypi.org/project/egile-mcp-starter)
[![Tests](https://github.com/jpoullet2000/egile-mcp-starter/actions/workflows/ci.yml/badge.svg)](https://github.com/jpoullet2000/egile-mcp-starter/actions/workflows/ci.yml)
[![Python Versions](https://img.shields.io/pypi/pyversions/egile-mcp-starter.svg)](https://pypi.org/project/egile-mcp-starter)
[![License](https://img.shields.io/github/license/jpoullet2000/egile-mcp-starter.svg)](https://github.com/jpoullet2000/egile-mcp-starter/blob/main/LICENSE)
[![Documentation](https://readthedocs.org/projects/egile-mcp-starter/badge/?version=latest)](https://egile-mcp-starter.readthedocs.io/en/latest/?badge=latest)

A comprehensive cookiecutter template for creating Model Context Protocol (MCP) servers using the FASTMCP framework.

```{toctree}
:maxdepth: 2
:caption: Contents

installation
quickstart
templates
configuration
server_types
api_reference
contributing
changelog
```

## What is egile-mcp-starter?

egile-mcp-starter is a comprehensive cookiecutter template that helps you quickly scaffold Model Context Protocol (MCP) servers using the FASTMCP framework. It provides a complete development environment with modern Python tooling, testing, and deployment configurations.

## Key Features

- 🚀 **Modern Python Setup**: Uses Poetry for dependency management and packaging
- 🏗️ **FASTMCP Framework**: Built on the efficient FASTMCP framework for MCP servers  
- � **Plugin Architecture**: Extensible template system with multiple server types
- 🧠 **RAG Template**: Advanced template with vector database support (Chroma, Pinecone, Weaviate, Qdrant, FAISS)
- 🧪 **Testing Ready**: Comprehensive test suite with pytest and coverage
- 🔧 **Development Tools**: Pre-configured with Black, Flake8, MyPy, and pre-commit hooks
- 🐳 **Docker Support**: Optional Docker configuration for easy deployment
- 🔄 **CI/CD Ready**: GitHub Actions workflows for automated testing and deployment
- 📚 **Rich Documentation**: Detailed README and code documentation
- 🎛️ **Configurable**: YAML-based configuration with environment variable support

## Quick Links

- [Installation Guide](installation.md)
- [Quick Start Tutorial](quickstart.md) 
- [Configuration Options](configuration.md)
- [Server Types](server_types.md)
- [API Reference](api_reference.md)
- [GitHub Repository](https://github.com/jpoullet2000/egile-mcp-starter)
- [PyPI Package](https://pypi.org/project/egile-mcp-starter)

## Indices and tables

* {ref}`genindex`
* {ref}`modindex`
* {ref}`search`