graph TD
    A[Claude AI Agent] --> B[MCP Protocol]
    B --> C{Transport Mode}
    C --> D[Stdio Mode<br/>Claude Code CLI]
    C --> E[HTTP/SSE Mode<br/>Web API]

    D --> F[Tool Registry<br/>53 Specialized Tools]
    E --> F

    F --> G[Core Services Layer]

    G --> H[Academic Operations<br/>Courses, Departments, Merit]
    G --> I[Student Services<br/>Library, Hostel, Transport]
    G --> J[Admission System<br/>Multi-step Forms]
    G --> K[Administrative Tools<br/>Faculty, Events, News]

    H --> L[(SQLite Database<br/>25 Tables)]
    I --> L
    J --> L
    K --> L

    style A fill:#e1f5fe
    style F fill:#f3e5f5
    style L fill:#e8f5e8

flowchart TB
    subgraph "MCP Transport Layer"
        TL1[Claude Desktop<br/>Stdio Transport]
        TL2[Claude Code CLI<br/>Direct Integration]
        TL3[HTTP/SSE Server<br/>REST API Access]
    end

    subgraph "Tool Processing Layer"
        TP[Tool Registry & Router<br/>53 Tools, 17 Categories]
        TP --> AV[Authentication & Validation<br/>JWT + bcrypt]
        AV --> DB[Database Abstraction<br/>SQLite with ORM]
    end

    subgraph "Service Modules"
        SM1[Academic Services<br/>6 Tools]
        SM2[Admission Services<br/>11 Tools]
        SM3[Student Services<br/>16 Tools]
        SM4[Administrative Services<br/>20 Tools]
    end

    TL1 --> TP
    TL2 --> TP
    TL3 --> TP

    DB --> SM1
    DB --> SM2
    DB --> SM3
    DB --> SM4

    subgraph "Data Layer"
        DL[(University Database<br/>25 Tables, Seed Data)]
    end

    SM1 --> DL
    SM2 --> DL
    SM3 --> DL
    SM4 --> DL

    style TL1 fill:#bbdefb
    style TL2 fill:#c8e6c9
    style TL3 fill:#fff9c4
    style TP fill:#f3e5f5
    style DL fill:#e8f5e8

pie title MCP Tools Distribution (53 Total Tools)
    "Academic Operations" : 6
    "Admission System" : 11
    "Student Services" : 16
    "Administrative" : 20

# System Requirements
✓ Python 3.10+
✓ Git (for development)
✓ Claude Desktop or Claude Code CLI
✓ 500MB free space
✓ Internet connection

sequenceDiagram
    participant User
    participant GitHub
    participant Python
    participant Claude

    User->>GitHub: git clone https://github.com/SARAMALI15792/InstituaionMCPServer.git
    GitHub-->>User: Repository downloaded
    User->>Python: cd InstituaionMCPServer && pip install -e .
    Python-->>User: Dependencies installed
    User->>Claude: Configure MCP Server
    Claude-->>User: Ready to use 53 tools!

# Step 1: Clone the repository
git clone https://github.com/SARAMALI15792/InstituaionMCPServer.git
cd InstituaionMCPServer

# Step 2: Install dependencies
pip install -e .
# or using uv (faster): uv pip install -e .

# Step 3: Configure environment
cp .env.example .env
# Edit .env with your settings

# Step 4: Run the server
python -m server.cli  # For Claude Code CLI
# OR
python -m server.main # For HTTP/SSE API (http://localhost:8000)

# Install from PyPI
pip install uaar-university-mcp

# Configure Claude Code
# Copy claude-code-config-pypi.json to your Claude Code config directory

graph LR
    A[Your Computer] --> B[Claude Desktop/Code]
    B --> C[MCP Server<br/>InstituaionMCPServer]
    C --> D[University Database]
    C --> E[53 Tools]

    B -->|Ask about| F[Courses]
    B -->|Check| G[Admissions]
    B -->|Manage| H[Student Services]
    B -->|Access| I[Admin Tools]

    style B fill:#ffebee
    style C fill:#e8f5e8

// claude-code-config-pypi.json (included)
{
  "mcpServers": {
    "uaar-university": {
      "command": "python",
      "args": ["-m", "server.cli"],
      "description": "UAAR University MCP Server - Academic resources, admissions, student services"
    }
  }
}

# AI Agent Conversation Flow
User: "I want to apply for Computer Science admission"
Agent: Uses `check_admission_status()` → "Admissions open"
Agent: Uses `start_admission_form()` → Creates APP-2026-00001
Agent: Guides through `fill_admission_field()` step-by-step
Agent: Uses `preview_admission_form()` → Shows application summary
Agent: Uses `confirm_and_submit_admission_form()` → Submission complete

User: "What's my GPA and available scholarships?"
Agent: Uses `get_cgpa(student_id)` → "Your CGPA is 3.75"
Agent: Uses `list_scholarships()` → Lists 15 available scholarships
Agent: Uses `check_scholarship_eligibility()` → "You qualify for 5 scholarships"
Agent: Uses `get_class_schedule()` → "Your Monday classes: CS301, MA202"

User: "Who are the CS department faculty and their research areas?"
Agent: Uses `search_faculty("Computer Science")` → Lists 12 faculty members
Agent: Uses `get_department_contact()` → Provides department contact info
Agent: Uses `list_upcoming_events()` → Shows department seminars

InstituaionMCPServer/
├── 📁 .claude/                    # AI Agent Configuration
│   └── 📄 claude.md              # Comprehensive AI documentation
├── 📁 server/                     # Core Server Implementation
│   ├── 🐍 main.py                # FastAPI HTTP/SSE transport
│   ├── 🐍 cli.py                 # CLI stdio transport
│   ├── 🐍 database.py            # SQLite ORM (441 lines)
│   ├── 🐍 auth.py                # JWT authentication
│   ├── 🐍 schemas.py             # Pydantic models
│   └── 📁 tools/                 # 53 MCP Tools
│       ├── 🐍 __init__.py        # Tool registry
│       ├── 🐍 academic_tools.py  # Academic operations
│       ├── 🐍 admission_form_tools.py # Multi-step forms
│       ├── 🐍 result_tools.py    # GPA calculation
│       └── ... 14 more modules
├── 📄 pyproject.toml             # Project dependencies
├── 📄 .env.example               # Environment template
├── 📄 .gitignore                 # Git exclusions
├── 📄 LICENSE                    # MIT License
├── 📄 README.md                  # This documentation
├── 📄 claude-code-config-pypi.json # Claude integration
└── 📄 requirements.txt           # Python dependencies

erDiagram
    departments ||--o{ courses : offers
    departments ||--o{ faculty : employs
    departments ||--|| merit_lists : publishes

    users ||--o{ results : achieves
    users ||--o{ admission_forms : submits

    courses ||--o{ class_schedule : scheduled_in
    courses ||--o{ exam_schedule : examined_in

    library_books ||--o{ borrowed_books : borrowed_by
    hostel_rooms ||--o{ hostel_fees : charged_for
    bus_routes ||--o{ bus_stops : stops_at

    events ||--|| news : related_to
    scholarships ||--o{ scholarship_applications : applied_for

    departments {
        string id PK
        string name
        string faculty
        string description
    }

    courses {
        string code PK
        string title
        string department_id FK
        int credit_hours
    }

    users {
        string id PK
        string name
        string email
        string role
    }

flowchart TD
    A[Identify Need] --> B[Create Tool Module]
    B --> C[Define Async Function]
    C --> D[Add Type Hints & Docstring]
    D --> E[Register with @mcp.tool decorator]
    E --> F[Add to Tool Registry]
    F --> G[Test with Claude]
    G --> H[Document & Deploy]

    style A fill:#e1f5fe
    style H fill:#c8e6c9

@mcp.tool(
    name="search_courses",
    annotations={
        "readOnlyHint": True,
        "destructiveHint": False,
        "idempotentHint": True,
        "openWorldHint": False
    }
)
async def search_courses(query: str) -> Dict:
    """
    Search university courses by name or code.

    Args:
        query: Search term (course name or code)

    Returns:
        List of matching courses with details

    Example:
        "Find computer science courses" → List of CS courses
    """
    results = query_db(
        "SELECT * FROM courses WHERE title LIKE ? OR code LIKE ?",
        [f"%{query}%", f"%{query}%"]
    )
    return {
        "data": results,
        "count": len(results),
        "message": f"Found {len(results)} courses matching '{query}'"
    }

# Test the server
python -m server.main &
SERVER_PID=$!

# Test API endpoints
curl http://localhost:8000/token -X POST -d "username=admin&password=admin"
# Use token for protected routes

kill $SERVER_PID

# Test CLI mode
python -m server.cli
# Use MCP client to test tools

graph TB
    subgraph "Authentication Layer"
        A[Client Request] --> B[JWT Token Validation]
        B --> C[Role-Based Access Control]
        C --> D[Permission Checking]
    end

    subgraph "Data Protection"
        E[Input Validation] --> F[SQL Injection Prevention]
        F --> G[Data Encryption]
        G --> H[Audit Logging]
    end

    subgraph "Network Security"
        I[HTTPS Enforcement] --> J[Rate Limiting]
        J --> K[IP Whitelisting]
        K --> L[DDoS Protection]
    end

    style B fill:#ffcdd2
    style F fill:#c8e6c9
    style I fill:#bbdefb

FROM python:3.10-slim
WORKDIR /app
COPY . .
RUN pip install -e .
EXPOSE 8000
CMD ["python", "-m", "server.main"]

# Build and run
docker build -t uaar-mcp-server .
docker run -p 8000:8000 -v ./data:/app/data uaar-mcp-server

# Production setup
sudo apt update
sudo apt install python3.10 python3-pip nginx
git clone https://github.com/SARAMALI15792/InstituaionMCPServer.git
cd InstituaionMCPServer
pip install -e .
cp .env.example .env.production
# Configure .env.production with production values

# Run with gunicorn
pip install gunicorn
gunicorn server.main:app -w 4 -k uvicorn.workers.UvicornWorker

Copyright (c) 2026 PMAS Arid Agriculture University Rawalpindi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

@software{uaar_mcp_server_2026,
  title = {UAAR University MCP Server},
  author = {UAAR IT Department and Contributors},
  year = {2026},
  url = {https://github.com/SARAMALI15792/InstituaionMCPServer}
}