What is Cs2620 Final Project Mcp

cs2620-final-project-MCP is a project developed as part of the CS2620 course, focusing on creating a multi-client server application using the MCP framework.

Use cases

Use cases include online collaborative tools, chat applications, and any scenario where multiple users need to interact in real-time.

How to use

To use cs2620-final-project-MCP, clone the repository from GitHub, install the necessary dependencies, and run the server using the provided command in the terminal.

Key features

Key features include multi-client support, real-time data processing, and a user-friendly interface for interaction.

Where to use

cs2620-final-project-MCP can be used in educational settings for learning about server-client architecture, as well as in small-scale applications requiring multi-user interaction.

CS2620 Final Project - MCP (Multi-Service Client Platform)

A distributed system with multiple microservices including calendar, todo, and weather services.

Table of Contents

• Overview
• Project Structure
• Requirements
• Installation
• Environment Setup
• Running the Services
• API Services

Overview

This project implements a distributed system with multiple microservices communicating via gRPC. The system includes:

• Calendar Service (appointment management)
• Todo Service (task management)
• Weather Service (weather data retrieval with Weather API integration)
• Todo Service (task management with SQLite persistence)

The weather service integrates with the Weather API to provide real-time weather data.

Project Structure

├── client/               # Client-side code
├── server/               # Server-side code
│   ├── calendar_server.py   # Calendar service
│   ├── todo_server.py       # Todo service
│   ├── weather_server.py    # Weather service with Weather API integration
│   └── weather_service.py   # Weather service implementation
├── protocol_pb2.py       # gRPC protocol definitions (compiled)
├── protocol_pb2_grpc.py  # gRPC service stubs (compiled)
├── run_servers.py        # Script to run all servers
└── .env.example          # Example environment variables configuration

Requirements

• Python 3.7+
• gRPC and Protocol Buffers
• Requests library (for API calls)
• python-dotenv (for environment variable management)

Installation

1. Clone the repository:

git clone https://github.com/CarlisleMa/cs2620-final-project-MCP.git
cd cs2620-final-project-MCP

2. Install the required packages:

pip install grpcio grpcio-tools protobuf requests python-dotenv

Environment Setup

This project requires environment variables for the Weather API integration. Here’s how to set them up:

Using a .env File (Recommended)

1. Copy the example file:

   cp .env.example .env
   

2. Edit the .env file and replace the placeholder values with your actual API keys and configuration.

3. Install python-dotenv to load variables from the .env file:

   pip install python-dotenv
   

4. The system will automatically load these variables if python-dotenv is installed.

Setting Environment Variables Manually

On macOS/Linux

For the current terminal session only:

export WEATHER_API_KEY=your_api_key_here

To make it permanent:

1. Edit your shell configuration file (~/.bash_profile, ~/.bashrc, or ~/.zshrc):

   echo 'export WEATHER_API_KEY=your_api_key_here' >> ~/.bashrc
   

2. Reload your shell configuration:

   source ~/.bashrc   # or source ~/.zshrc for Zsh
   

On Windows

For the current Command Prompt session only:

set WEATHER_API_KEY=your_api_key_here

For the current PowerShell session only:

$env:WEATHER_API_KEY = "your_api_key_here"

To make it permanent via GUI:

1. Search for “Edit environment variables for your account” in the Start menu
2. Click “New” to add a new variable
3. Enter “WEATHER_API_KEY” for the name and your API key for the value
4. Click “OK” to save

Getting a Weather API Key

1. Sign up for an account at weatherapi.com
2. After signing in, go to your Dashboard
3. Copy your API key from the dashboard
4. Set it in your environment as described above

Running the Services

Run All Services at Once

To start all services (Calendar, Todo, and Weather):

python3 run_servers.py

This will start:

• Weather Server on port 50052
• Todo Server on port 50053
• Calendar Server on port 50054

Run Individual Services

To run specific services individually:

# Run the Weather Service
python3 -m server.weather_server

# Run the Todo Service
python3 -m server.todo_server

# Run the Calendar Service
python3 -m server.calendar_server

Running the Client

After starting the services, you can run the client application to interact with all three services. The client provides an interactive interface to view weather, manage tasks, schedule events, and generate daily agendas.

Interactive Agenda Client

python3 -m client.agenda_client

This will start an interactive terminal interface with the following commands:

• agenda - Display your daily agenda (combines weather, tasks, and events)
• add event - Add a calendar event
• add task - Add a todo task
• weather [location] - Get weather for a specific location
• exit - Exit the application

Programmatic Usage

You can also use the client API programmatically in your own Python code:

from client.agenda_client import AgendaClient

# Initialize the client with your credentials
client = AgendaClient(client_id="your_client_id", api_key="your_api_key")

# Generate an agenda
agenda = client.generate_daily_agenda()
print(agenda)

# Get weather for a location
weather = client.get_weather("London")
print(weather)

# Add a task
client.add_task(
    "Complete project",
    "Finish the distributed system project",
    "2025-05-01",
    "high"
)

API Services

Weather Service

The Weather Service provides current weather and forecast data. It integrates with Weather API for real data but falls back to mock data if the API key is not configured or if there’s an API error.

Key Methods:

• get_current_weather: Get current weather for a location
• get_forecast: Get a multi-day weather forecast for a location

Todo Service

The Todo Service allows for task management with persistent storage using SQLite:

Key Methods:

• Task creation, retrieval, updating, and deletion
• Task listing and filtering

Persistence:

• Tasks are stored in a SQLite database located in the data/todo.db file
• Data persists between server restarts
• Automatic database creation and initialization

Calendar Service

The Calendar Service manages appointments and events:

Key Methods:

• Event creation, retrieval, updating, and deletion
• Calendar views and scheduling