Add your description here
Project description
Appointment Scheduler MCP Server
A Model Context Protocol (MCP) server that connects to a PostgreSQL database to manage appointment scheduling. Built with FastMCP, SQLAlchemy, and Alembic for database migrations.
๐ Features
- Database Integration: PostgreSQL database with SQLAlchemy ORM
- MCP Protocol: Supports both stdio and HTTP transport modes
- Database Migrations: Alembic for schema management and migrations
- Appointment Management: Schedule appointments with validation
- Docker Support: Containerized deployment with Docker Compose
- Environment Configuration: Secure credential management with .env files
๐ Prerequisites
- Python 3.13+
- PostgreSQL database
- uv package manager (recommended) or pip
๐ ๏ธ Installation
Using uv (Recommended)
# Clone the repository
git clone https://github.com/Juan-Andres-Motta/backend-mcp.git
cd backend-mcp
# Install dependencies
uv sync
Using pip
# Clone the repository
git clone https://github.com/Juan-Andres-Motta/backend-mcp.git
cd backend-mcp
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
โ๏ธ Configuration
Environment Variables
Create a .env file in the project root:
# Database Configuration
DB_HOST=localhost
DB_PORT=5432
DB_NAME=your_database_name
DB_USER=your_username
DB_PASSWORD=your_password
# Database URL (constructed from above)
DATABASE_URL=postgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}
# MCP Server Configuration
MCP_TRANSPORT=stdio # Options: stdio, http
MCP_HOST=0.0.0.0 # Only used for HTTP transport
MCP_PORT=8000 # Only used for HTTP transport
Database Setup
-
Using Docker Compose (Recommended):
docker-compose up -d postgres
-
Manual PostgreSQL Setup:
- Install PostgreSQL
- Create a database
- Update
.envwith your database credentials
Database Migrations
Run database migrations to create the appointments table:
# Using uv
uv run alembic upgrade head
# Using pip
alembic upgrade head
๐ Running the Server
Development Mode (stdio)
# Using uv
uv run python main.py
# Using pip
python main.py
HTTP Mode
Set MCP_TRANSPORT=http in your .env file:
# Using uv
uv run python main.py
# Using pip
python main.py
The server will be available at http://localhost:8000
Docker Deployment
# Build and run with Docker Compose
docker-compose up --build
# Run only the MCP server (requires external PostgreSQL)
docker build -t appointment-mcp .
docker run --env-file .env appointment-mcp
๐ API Usage
MCP Tool: schedule_appointment
Schedules a new appointment in the database.
Parameters:
name(string): Full name of the person scheduling the appointmentidentification_number(string): Identification number (ID card, passport, etc.)phone(string): Phone numberdate(string): Appointment date and time in ISO format (YYYY-MM-DDTHH:MM:SS)
Example:
{
"name": "John Doe",
"identification_number": "123456789",
"phone": "+1234567890",
"date": "2024-12-25T14:30:00"
}
Response:
{
"result": "Success: Appointment scheduled for John Doe on 2024-12-25 14:30:00 (ID: 1)"
}
๐๏ธ Project Structure
backend-mcp/
โโโ main.py # Main MCP server application
โโโ pyproject.toml # Project dependencies and configuration
โโโ uv.lock # uv lock file
โโโ alembic/ # Database migration files
โ โโโ env.py
โ โโโ script.py.mako
โ โโโ versions/
โโโ .env # Environment variables (create this)
โโโ .env.example # Environment variables template
โโโ Dockerfile # Docker container configuration
โโโ docker-compose.yml # Docker Compose configuration
โโโ .dockerignore # Docker ignore file
โโโ .gitignore # Git ignore file
โโโ README.md # This file
๐ง Development
Running Tests
# Install development dependencies
uv sync --dev
# Run tests
uv run pytest
Database Schema
The appointments table structure:
CREATE TABLE appointments (
id SERIAL PRIMARY KEY,
name VARCHAR(255) NOT NULL,
identification_number VARCHAR(50) NOT NULL,
phone VARCHAR(20) NOT NULL,
date TIMESTAMP NOT NULL
);
Adding New Features
- Define new MCP tools in
main.py - Update database models if needed
- Create Alembic migrations for schema changes
- Update this README
๐ค Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
๐ Troubleshooting
Common Issues
-
Database Connection Error
- Check your
.envfile configuration - Ensure PostgreSQL is running
- Verify database credentials
- Check your
-
Migration Errors
- Run
alembic currentto check migration status - Run
alembic upgrade headto apply pending migrations
- Run
-
MCP Transport Issues
- For stdio mode: Ensure the MCP client supports stdio transport
- For HTTP mode: Check that the port is not in use
Getting Help
- Check the FastMCP documentation
- Review SQLAlchemy documentation
- Check Alembic documentation
๐ Version History
- v1.0.0: Initial release with basic appointment scheduling functionality
- Database integration with PostgreSQL
- Docker containerization
- MCP protocol support (stdio and HTTP)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file backend_mcp_fastmcp-0.1.1.tar.gz.
File metadata
- Download URL: backend_mcp_fastmcp-0.1.1.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ce6f398a286b4783f2432ca7fe2a4f04ed08fba53eff69f6ac622d890a53951
|
|
| MD5 |
a5b2dbf252fd84d7c04a26ef35611907
|
|
| BLAKE2b-256 |
a93bc508586364a07d59a6be56d7bb3fc6ad07522198830bdec8371e3de9b346
|
File details
Details for the file backend_mcp_fastmcp-0.1.1-py3-none-any.whl.
File metadata
- Download URL: backend_mcp_fastmcp-0.1.1-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
85ba0475f6d6d718c6b398cd801bca28c43eb1a4c3b492f664666080e118fe21
|
|
| MD5 |
10e2a487b267395a30797469fdce94e2
|
|
| BLAKE2b-256 |
4de52e444085916472a2bdd5f3b45a8243f5ee864e5139f213718ccd14eb1f71
|