Personal Assistant MCP Server with SQLite/TinyDB support for status tracking, project management, todos, calendar functionality, and document storage
Project description
MCP Personal Assistant
A comprehensive MCP (Model Context Protocol) server for personal productivity management, including status tracking, project management, todos, calendar functionality, and document storage.
Features
๐ Status Management
- Track your current location, laptop details, and system permissions
- View a dashboard of active projects and upcoming tasks
- Update your personal information and system status
๐ Project Management
- Create and manage projects with customizable status and priority
- Add tasks to projects with due dates and priorities
- Track project progress with percentage completion
- Filter projects by status (not started, in progress, on hold, completed, cancelled)
โ Todo Management
- Create and manage todos with due dates and reminders
- Set priority levels (low, medium, high, urgent)
- Mark todos as completed
- Filter todos by completion status
๐ Calendar Management
- Create calendar events with start/end times
- Set event locations and attendee lists
- Configure reminder notifications
- View events within date ranges
๐ Document Management
- Upload and store documents (PDFs, images, text files, etc.)
- Create references to external documents (cloud storage links)
- Tag and organize documents
- Support for encrypted storage
- Automatic file type detection and categorization
Installation & Setup
Prerequisites
- Python 3.10 or higher
- Claude Desktop application
Installation Options
Option 1: Install from PyPI (Recommended)
Using uvx (recommended):
uvx install mcp-personal-assistant
Using pipx:
pipx install mcp-personal-assistant
Using pip:
pip install mcp-personal-assistant
Option 2: Install from Source (Development)
Step 1: Clone the Repository
git clone <repository-url>
cd mcp-pa
Step 2: Create Virtual Environment
python3 -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
Step 3: Install Dependencies
pip install -r requirements.txt
pip install -e . # Install in development mode
Configuration
The MCP server can be configured using environment variables:
Database Configuration
MCP_PA_DB_TYPE: Database type (sqliteortinydb, default:sqlite)MCP_PA_DB_PATH: Custom database file pathMCP_PA_ENCRYPTION_KEY: Encryption key for database (optional)
Storage Configuration
MCP_PA_DOCS_DIR: Directory for document storageMCP_PA_MAX_FILE_SIZE_MB: Maximum file size in MB (default: 100)
Default Locations
- macOS:
~/Library/Application Support/mcp-pa/ - Linux:
~/.config/mcp-pa/ - Windows:
%APPDATA%\mcp-pa\
To use specific settings:
export MCP_PA_DB_TYPE=sqlite
export MCP_PA_ENCRYPTION_KEY=mysecretkey
export MCP_PA_DOCS_DIR=/path/to/documents
Claude Desktop Configuration
-
Locate your Claude Desktop configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
-
Add the MCP server configuration:
For PyPI Installation (uvx/pipx/pip):
{
"mcpServers": {
"personal-assistant": {
"command": "uvx",
"args": ["mcp-personal-assistant"],
"env": {
"MCP_PA_DB_TYPE": "sqlite"
}
}
}
}
For Source Installation:
{
"mcpServers": {
"personal-assistant": {
"command": "/path/to/your/mcp-pa/venv/bin/python",
"args": ["-m", "src.server"],
"cwd": "/path/to/your/mcp-pa",
"env": {
"MCP_PA_DB_TYPE": "sqlite"
}
}
}
}
Notes for Source Installation:
- Use the full path to your virtual environment's Python executable
- Use the full path to your project directory in the
cwdfield - On Windows, use forward slashes or escaped backslashes in paths
- Restart Claude Desktop for the configuration to take effect
Usage Examples
Once configured, the MCP Personal Assistant integrates seamlessly with Claude Desktop. Here are some examples of how it works:
Claude Desktop Settings
You can configure Claude with custom instructions to automatically use the MCP Personal Assistant tools for status updates and project management.
MCP Server Status
The server appears in Claude Desktop's developer settings, showing it's running and properly configured.
Creating Projects
You can ask Claude to create projects, and it will use the MCP Personal Assistant tools to manage your project data.
Managing Project Data
The assistant can update project status, add tasks, and maintain detailed project information with automatic data persistence.
Intelligent Assistance
Claude can access your status and project history to provide personalized recommendations and assistance based on your stored preferences and travel history.
Verification
After restarting Claude Desktop, you should see the MCP Personal Assistant tools available. You can verify the setup by:
- Asking Claude to use the
get_statustool - Creating a test project with
create_project - Viewing the dashboard with
get_dashboard
If you encounter issues, check the Claude Desktop logs at:
- macOS:
~/Library/Logs/Claude/mcp-server-personal-assistant.log
Quick Start Examples
๐ PyPI Installation Quick Start
# Install the package
uvx install mcp-personal-assistant
# Copy the Claude Desktop config template (update paths as needed)
cp examples/claude_desktop_config.json ~/Library/Application\ Support/Claude/claude_desktop_config.json
# Restart Claude Desktop
๐งช Test the Installation
# Test the console script
mcp-personal-assistant --help
# Run the basic usage example to verify everything works
python examples/basic_usage.py
๐ Template Files
The examples/ directory contains ready-to-use templates and scripts:
claude_desktop_config.json- Template configuration for Claude Desktopbasic_usage.py- Standalone script to test functionality- Usage screenshots showing the MCP in action
Available Tools
Status Management
get_status
Get your current status including location, laptop details, permissions, and system information.
update_status
Update your status information.
Project Management
create_project
Create a new project with name, description, status, priority, dates, and tags.
list_projects
List all projects or filter by status.
get_project
Get detailed information about a specific project.
update_project
Update project information including status, priority, and progress.
add_project_task
Add a task to a project.
Todo Management
create_todo
Create a new todo with title, description, due date, priority, and tags.
list_todos
List all todos with optional completion status filter.
complete_todo
Mark a todo as completed.
Calendar Management
create_calendar_event
Create a calendar event with start/end times, location, and attendees.
list_calendar_events
List calendar events within a date range.
Document Management
upload_document
Upload a document with base64 encoded content.
Parameters:
- title: Document filename
- content_base64: Base64 encoded file content
- description: Optional description
- tags: Optional tags array
create_external_document
Create a reference to an external document.
Parameters:
- title: Document title
- external_url: URL to external document
- description: Optional description
- tags: Optional tags array
list_documents
List all documents with optional tag filtering.
get_document
Get detailed information about a specific document.
Dashboard
get_dashboard
Get a comprehensive dashboard view of all activities.
Database Support
SQLite (Default)
- Better performance for larger datasets
- ACID compliance with transaction support
- Thread-safe with connection pooling
- Efficient concurrent access
- Supports database encryption
TinyDB
- Simple JSON-based storage
- Human-readable database file
- Supports encryption via Fernet
- Good for smaller datasets
- Easy to backup and inspect
Document Storage
The document manager supports:
- Automatic file type detection
- SHA-256 checksum calculation
- File size validation
- Metadata tagging
- External document references
Supported document types:
- PDF files
- Images (JPEG, PNG, etc.)
- Text files
- Spreadsheets (Excel, CSV)
- Presentations (PowerPoint)
- Other file types
Security Features
Database Encryption
- SQLite: Can use SQLCipher for encryption (if available)
- TinyDB: Uses Fernet symmetric encryption
- Encryption key configurable via environment variable
Document Security
- Files stored with unique IDs
- Original filenames preserved in metadata
- Checksum verification for integrity
- File size limits enforced
Advanced Usage
Using with Multiple Instances
The server supports concurrent access from multiple clients:
- SQLite uses connection pooling
- TinyDB uses thread-safe locking
- Both handle concurrent read/write operations
Custom Database Location
export MCP_PA_DB_PATH=/custom/path/database.sqlite
Encrypted Database
export MCP_PA_ENCRYPTION_KEY=your-secure-key-here
Project Structure
mcp-personal-assistant/
โโโ README.md # Main documentation
โโโ pyproject.toml # Package configuration
โโโ requirements.txt # Core dependencies
โโโ LICENSE # License file
โโโ pytest.ini # Test configuration
โโโ Makefile # Build automation
โ
โโโ src/ # Source code
โ โโโ __init__.py
โ โโโ server.py # Main MCP server
โ โโโ config.py # Configuration management
โ โโโ models.py # Data models
โ โโโ database_interface.py
โ โโโ database_factory.py
โ โโโ sqlite_database.py
โ โโโ tinydb_database.py
โ โโโ document_manager.py
โ โโโ config/ # Configuration modules
โ
โโโ examples/ # Usage examples
โ โโโ README.md
โ โโโ claude_desktop_config.json
โ โโโ basic_usage.py
โ
โโโ docs/ # Documentation
โ โโโ quickstart.md
โ โโโ architecture.md
โ โโโ cloud-architecture.md
โ โโโ security.md
โ โโโ development-notes.md
โ
โโโ tests/ # Test files
โ
โโโ scripts/ # Utility scripts
โ โโโ check_performance_regression.py
โ โโโ run_http_server.py
โ โโโ run_tests.sh
โ โโโ test_framework_validation.py
โ
โโโ deployment/ # Deployment files
โ โโโ docker-compose.yml
โ โโโ Dockerfile
โ โโโ init-db.sql
โ
โโโ archive/ # Development artifacts
โโโ old requirements files
โโโ development reports
Running Tests
python test_server.py
Building the Package
pip install build
python -m build
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
MIT License - see LICENSE file for details.
Troubleshooting
Common Setup Issues
-
"ModuleNotFoundError: No module named 'src'"
- Ensure you've installed the package in development mode:
pip install -e . - Verify you're using the virtual environment's Python:
/path/to/venv/bin/python
- Ensure you've installed the package in development mode:
-
"spawn python ENOENT"
- Use the full path to Python executable in Claude Desktop config
- Don't use just
python- use/path/to/your/mcp-pa/venv/bin/python
-
"Server disconnected" errors
- Check that all dependencies are installed:
pip install -r requirements.txt - Verify the
cwdpath points to your project directory - Check Claude Desktop logs for specific error messages
- Check that all dependencies are installed:
-
"Unknown resource" errors
- This usually indicates a configuration issue
- Restart Claude Desktop after making config changes
- Ensure the server is properly installed with
pip install -e .
Log Files
Check these log files for debugging:
- macOS:
~/Library/Logs/Claude/mcp-server-personal-assistant.log - Linux:
~/.config/Claude/logs/mcp-server-personal-assistant.log - Windows:
%APPDATA%\Claude\logs\mcp-server-personal-assistant.log
Testing the Server Directly
You can test the server functionality outside of Claude Desktop:
# Activate virtual environment
source venv/bin/activate
# Test basic imports
python -c "import src.server; print('Server imports successfully')"
# Test database connection
python -c "from src.database_factory import get_database; db = get_database(); print('Database connected')"
Other Common Issues
-
Database Connection Errors
- Ensure the database directory exists
- Check file permissions
- Verify encryption key if using encryption
-
Document Upload Failures
- Check file size limits
- Ensure documents directory is writable
- Verify base64 encoding is correct
-
Configuration Problems
- Check environment variables
- Verify the configuration file syntax
- Ensure all required directories exist
Future Enhancements
- File preview generation
- Full-text search across documents
- Automatic backup system
- OAuth integration for cloud storage
- Web interface for direct access
- Plugin system for extensibility
- Real-time notifications
- Database migration tools
Support
For issues and feature requests, please create an issue in the GitHub repository.
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 mcp_personal_assistant-0.2.1.tar.gz.
File metadata
- Download URL: mcp_personal_assistant-0.2.1.tar.gz
- Upload date:
- Size: 652.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3224a47c5a0c831ae02e7c0378784a812ecf917dbbc440bd807b39b8f891589b
|
|
| MD5 |
43c5e46dd4f2853684f8c37b03485fbd
|
|
| BLAKE2b-256 |
7ba959ff8c91f9acef9f0b833f2c9d9109543273ded776814695e0d5b014296e
|
File details
Details for the file mcp_personal_assistant-0.2.1-py3-none-any.whl.
File metadata
- Download URL: mcp_personal_assistant-0.2.1-py3-none-any.whl
- Upload date:
- Size: 95.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
348759e6b5a1a27cd5717da0950967cdfd1617244aec8ea1338b100e310c182f
|
|
| MD5 |
a57970546716ecab654258d887c8dd2a
|
|
| BLAKE2b-256 |
94643b454665cb984a2c214125d4786a100ccec58c0802181fdbf8427fb91d1b
|