Skip to main content
Glama
README.md
# ๐Ÿง‘โ€๐Ÿ’ผ HR Assist โ€” MCP Server

An **MCP (Model Context Protocol) server** that automates HR onboarding tasks โ€” HRMS registration, welcome emails, IT ticketing, meeting scheduling, and leave management โ€” so an AI agent like Claude can handle the entire new-hire workflow from a single prompt. ๐Ÿš€

---

## โœจ Features

| Area | What it does |
|---|---|
| ๐Ÿ‘ค **Employee Management** | Add employees, fetch details by (fuzzy) name search, look up managers & direct reports |
| ๐Ÿ“ง **Email** | Send plain-text or HTML emails (with optional attachments) via SMTP |
| ๐ŸŽซ **Ticketing** | Raise, update, and list IT/equipment tickets (laptop, ID card, etc.) |
| ๐Ÿ“… **Meetings** | Schedule, list, and cancel meetings for any employee |
| ๐ŸŒด **Leave Management** | Check leave balance, apply for leave, view leave history |
| โšก **Ready-made Prompt** | Built-in `onboard_new_employee` MCP prompt that chains all of the above into one onboarding flow |

---

## ๐Ÿ—‚๏ธ Project Structure

```
atliq-hr-assist/
โ”œโ”€โ”€ server.py              # FastMCP server โ€” defines all MCP tools & the onboarding prompt
โ”œโ”€โ”€ emails.py              # EmailSender โ€” SMTP email utility (plain/HTML + attachments)
โ”œโ”€โ”€ utils.py               # seed_services() โ€” seeds in-memory demo data
โ”œโ”€โ”€ HRMS/
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ employee_manager.py   # EmployeeManager โ€” employee CRUD + org hierarchy
โ”‚   โ”œโ”€โ”€ meeting_manager.py    # MeetingManager โ€” schedule/list/cancel meetings
โ”‚   โ”œโ”€โ”€ leave_manager.py      # LeaveManager โ€” leave balance & history
โ”‚   โ”œโ”€โ”€ ticket_manager.py     # TicketManager โ€” IT/equipment tickets
โ”‚   โ””โ”€โ”€ schemas.py            # Pydantic models for all entities
โ”œโ”€โ”€ pyproject.toml
โ”œโ”€โ”€ .python-version
โ”œโ”€โ”€ .gitignore
โ””โ”€โ”€ .env                   # ๐Ÿ”’ local secrets โ€” never committed
```

> ๐Ÿ“Œ Note: `server.py` does `from HRMS import *`, so the manager classes (`employee_manager.py`, `meeting_manager.py`, etc.) and `schemas.py` should live inside an `HRMS/` package folder alongside `__init__.py`.

---

## ๐Ÿ› ๏ธ Requirements

- ๐Ÿ Python **3.10+**
- Dependencies (see `pyproject.toml`):
  - `fastmcp>=3.4.5`
  - `mcp[cli]>=1.9.4`
  - `pydantic>=2.13.4`
  - `python-dotenv`

---

## โš™๏ธ Setup

### 1. Clone & install

```bash
git clone https://github.com/Vraj-Data-Scientist/hr-onboarding-agent-with-MCP.git
cd hr-onboarding-agent-with-MCP

# using uv (recommended)
uv sync

# or using pip
pip install -e .
```

### 2. Configure environment variables

Create a `.env` file in the project root (already git-ignored ๐Ÿ”’):

```env
EMAIL=your-smtp-email@gmail.com
EMAIL_PWD=your-app-specific-password
```

> โš ๏ธ **Security note:** Use a Gmail **App Password**, not your real account password, and never commit `.env` to version control. If real credentials were ever pushed to a repo, rotate/revoke them immediately.

### 3. Run the server standalone (optional, for testing)

```bash
python server.py
```

This starts the MCP server over **stdio** transport.

---

## ๐Ÿ”Œ Connecting to Claude as an MCP Client

This server speaks MCP over stdio, so it plugs directly into any MCP-compatible Claude client.

### ๐Ÿ–ฅ๏ธ Option A โ€” Claude Desktop

1. Open your Claude Desktop config file:
   - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
   - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
2. Add this server under `mcpServers`:

```json
{
  "mcpServers": {
    "hr-onboarding-agent": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/absolute/path/to/hr-onboarding-agent-with-MCP",
        "mcp",
        "run",
        "server.py"
      ],
      "env": {
        "EMAIL": "your-smtp-email@gmail.com",
        "EMAIL_PWD": "your-app-specific-password"
      }
    }
  }
}
```

  

3. Restart Claude Desktop. A ๐Ÿ”จ tools icon should appear, showing the `hr-assist` server connected with tools like `add_employee`, `send_email`, `create_ticket`, `schedule_meeting`, and more.
4. Prompt Claude naturally, e.g.:
   > "Onboard a new employee named Priya Nair reporting to Tony Sharma."


### ๐Ÿ’ก Using the built-in onboarding prompt

The server exposes a ready-made MCP prompt, `onboard_new_employee`, which Claude Desktop (via the `/` prompt picker) and Claude Code can surface directly โ€” just supply `employee_name` and `manager_name`, and the full onboarding flow runs end-to-end.

---

## ๐Ÿงช Example

**Prompt:**
```
Onboard a new employee with the following details:
- Name: Vraj Dobariya
- Manager Name: Tony Sharma
```

**What happens automatically:**
1. ๐Ÿ‘ค Employee added to HRMS with correct manager mapping
2. ๐Ÿ“ง Welcome email sent with generated login 
3. ๐Ÿ“จ Manager notified of the new hire
4. ๐ŸŽซ Tickets raised for laptop, ID card, and other equipment
5. ๐Ÿ“… Introductory meeting scheduled between employee and manager

---

Maintenance

ActivitySlowing
ResponsivenessNo issues