ELITEA MCP Client
Project description
EliteA MCP Client
A powerful and user-friendly MCP (Model Context Protocol) client with both command-line interface and system tray application. Provides seamless integration with the ELITEA platform for managing MCP servers and AI agents.
โจ Features
- ๐ฅ๏ธ System Tray Application - Easy-to-use GUI with cross-platform support
- ๐ Command Line Interface - Full-featured CLI for developers and automation
- ๐ง Interactive Bootstrap - Step-by-step configuration wizard
- ๐ Multiple Transports - Support for stdio and SSE (Server-Sent Events)
- ๐ Stateful & Stateless Sessions - Flexible server connection modes
- ๐ง Cross-Platform - Works on Windows, macOS, and Linux
- ๐ฆ Easy Installation - Available via PyPI with pipx support
- ๐ก๏ธ Production Ready - Comprehensive error handling and logging
Feature Comparison
| Feature | CLI Mode | Tray Mode | Daemon Mode |
|---|---|---|---|
| Server Management | โ Manual | โ GUI Controls | โ Background |
| Configuration | โ Bootstrap CMD | โ File/Wizard | โ File-based |
| User Interface | ๐ป Terminal | ๐ฅ๏ธ System Tray | ๐ Background |
| Auto-start | โ Manual | โ OS Integration | โ Service Mode |
| Resource Usage | ๐พ On-demand | ๐พ Minimal | ๐พ Continuous |
| Best For | Development | Daily Use | Production |
๐ Quick Start
Installation
Using pipx (Recommended)
# Install pipx if not already installed
pip install pipx
# Install elitea-mcp
pipx install elitea-mcp
Using pip
pip install elitea-mcp
Configuration
# Interactive configuration
elitea-mcp bootstrap
# Or with command line parameters
elitea-mcp bootstrap --deployment_url https://api.example.com --auth_token YOUR_TOKEN
Start System Tray Application
# Launch the system tray application
elitea-mcp tray
# Or run in background (daemon mode)
elitea-mcp tray --daemon
Example Usage
# 1. Configure the client
elitea-mcp bootstrap --deployment_url https://api.elitea.com --auth_token your_token_here
# 2. Run with a specific project
elitea-mcp run --project_id 123
# 3. Or start the tray app for GUI management
elitea-mcp tray
๐ Table of Contents
- Installation
- System Tray Application
- Command Line Usage
- Configuration
- Server Management
- Platform-Specific Notes
- Development
- Documentation
- Contributing
๐ป Installation
Prerequisites
- Python 3.10 or higher
- pip or pipx package manager
Method 1: Using pipx (Recommended)
pipx installs the package in an isolated environment while making CLI commands globally available.
macOS
# Install pipx
brew install pipx
pipx ensurepath
# Install elitea-mcp
pipx install elitea-mcp
# Add to shell profile (if needed)
echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.zprofile
source ~/.zprofile
Linux
# Install pipx
sudo apt install pipx # Ubuntu/Debian
# or
sudo dnf install pipx # Fedora
# or
pip install --user pipx
# Ensure PATH
pipx ensurepath
# Install elitea-mcp
pipx install elitea-mcp
Windows
# Install pipx
pip install --user pipx
python -m pipx ensurepath
# Install elitea-mcp
pipx install elitea-mcp
Method 2: Using pip
pip install elitea-mcp
Method 3: From Source
git clone https://github.com/EliteaAI/elitea-mcp-client.git
cd elitea-mcp-client
pip install -e .
๐ฎ System Tray Application
The system tray application provides an intuitive GUI for managing your MCP client without requiring terminal knowledge.
Features
- ๐ฅ๏ธ System Tray Integration - Minimalist icon in your system tray
- ๐ Configuration Management - Open config files, run bootstrap wizard
- ๐ Server Control - Start/stop MCP servers with different modes
- ๐ Real-time Status - Visual feedback for server operations
- ๐ Cross-Platform - Windows, macOS, and Linux support
- ๐ซ No GUI Dependencies - Works in all environments
Starting the Tray App
# Launch tray application
elitea-mcp tray
# Run in background (daemon mode)
elitea-mcp tray --daemon
# Using launch scripts (platform-specific)
./scripts/launch-tray-macos.sh # macOS
./scripts/launch-tray-windows.bat # Windows
Tray Menu Options
Right-click the tray icon to access:
Server Control
- Start MCP Server (Embedded) - Run servers within the tray process
- Start MCP Server (Daemon) - Run servers as background daemon
- Stop MCP Server - Stop running servers (shows current mode)
- Restart MCP Server - Reload configuration by stopping and starting servers
Configuration
- Open Config File - Edit JSON configuration in default text editor
- Open Config Folder - Open configuration directory in file manager
- Bootstrap (Terminal) - Run interactive configuration setup
- View Current Config - Display current settings via system notification
Application
- About - Application information and version
- Quit - Exit the tray application
Auto-Start Setup
macOS
# Copy launch script to Applications
cp scripts/launch-tray-macos.sh ~/Applications/
# Add to Login Items in System Preferences
# or create a Launch Agent (see docs/TRAY_SETUP_GUIDE.md)
Linux
# Add to autostart
mkdir -p ~/.config/autostart
cp scripts/elitea-mcp-tray.desktop ~/.config/autostart/
Windows
# Copy to Startup folder
# Press Win+R, type shell:startup, then copy launch-tray-windows.bat
๐ป Command Line Usage
Available Commands
elitea-mcp --help # Show all available commands
elitea-mcp bootstrap # Configure deployment URL and auth token
elitea-mcp run # Run MCP client with specific project/app
elitea-mcp serve # Start MCP servers in background
elitea-mcp tray # Launch system tray application
Running MCP Client
With Specific Application
# Run with specific project and application
elitea-mcp run --project_id YOUR_PROJECT_ID --app_id YOUR_APP_ID
# Include version (optional)
elitea-mcp run --project_id YOUR_PROJECT_ID --app_id YOUR_APP_ID --version_id YOUR_VERSION_ID
With All Project Agents
# Use all available agents in a project
elitea-mcp run --project_id YOUR_PROJECT_ID
Transport Options
# Default: stdio transport
elitea-mcp run --project_id YOUR_PROJECT_ID
# SSE transport for web applications
elitea-mcp run --project_id YOUR_PROJECT_ID --transport sse --port 8000
Server Management
# Start servers in background
elitea-mcp serve --daemon
# Custom PID and log files
elitea-mcp serve --daemon --pid-file /path/to/app.pid --log-file /path/to/app.log
# View running servers
ps aux | grep elitea-mcp
โ๏ธ Configuration
Configuration Locations
The client stores configuration in your OS's standard app data directory:
- Windows:
%APPDATA%\elitea-mcp-client - macOS:
~/Library/Application Support/elitea-mcp-client - Linux:
~/.config/elitea-mcp-client
Bootstrap Configuration
Interactive Mode
elitea-mcp bootstrap
This launches an interactive wizard that guides you through:
- Deployment URL - Your ELITEA platform endpoint
- Authentication Token - Your API authentication token
- Server Configuration - Host and port settings
- MCP Server Setup - Configure available MCP servers
- When prompted for Args, enter all arguments in a single line separated by spaces. They will be stored as a list in the configuration file.
Command Line Mode
elitea-mcp bootstrap \
--deployment_url https://api.example.com \
--auth_token YOUR_TOKEN \
--host 0.0.0.0 \
--port 8000
Configuration File Structure
{
"deployment_url": "https://api.example.com",
"auth_token": "your-auth-token",
"host": "0.0.0.0",
"port": 8000,
"servers": {
"server1": {
"command": "python",
"args": ["-m", "mcp_server"],
"env": {},
"stateful": false
}
}
}
๐ Server Management
Stateful vs Stateless Sessions
Stateless (Default)
- Each tool call creates a fresh connection
- Server state resets between calls
- Best for: File operations, API calls, simple commands
{
"servers": {
"api_server": {
"command": "python",
"args": ["-m", "api_mcp_server"],
"stateful": false
}
}
}
Stateful
- Maintains persistent connections
- Server state persists between calls
- Best for: Browser automation, database connections, complex workflows
{
"servers": {
"browser_server": {
"command": "python",
"args": ["-m", "playwright_mcp_server"],
"stateful": true
}
}
}
Daemon Mode
Run servers in the background for continuous operation:
# Start daemon
elitea-mcp serve --daemon
# Check status
ps aux | grep "elitea-mcp serve"
# Stop daemon (find PID and kill)
kill $(cat ~/.local/var/run/elitea-mcp/elitea-mcp-serve.pid)
๐ฅ๏ธ Platform-Specific Notes
macOS
- Fork Safety: Automatic handling of GUI framework compatibility
- Dock Integration: Tray app automatically hides from dock
- Launch Agents: Support for automatic startup
- Homebrew: Easy installation via pipx
Linux
- Desktop Entry: Autostart support via
.desktopfiles - System Tray: Compatible with GNOME, KDE, and other desktop environments
- Package Managers: Works with apt, dnf, pacman via pip/pipx
Windows
- System Tray: Native Windows system tray integration
- Startup Folder: Easy auto-start setup
- PowerShell: Full PowerShell compatibility
๐ ๏ธ Development
Setup Development Environment
# Clone repository
git clone https://github.com/EliteaAI/elitea-mcp-client.git
cd elitea-mcp-client
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install in editable mode
pip install -e .
# Install development dependencies
pip install -e ".[dev]"
Running Tests
# Run all tests
python -m pytest
# Run with coverage
python -m pytest --cov=elitea_mcp
# Run specific test file
python -m pytest tests/test_fork_safety.py -v
Building and Publishing
# Install build tools
pip install build twine
# Build the package
python -m build
# Upload to PyPI (requires authentication)
twine upload dist/*
๐ Documentation
Comprehensive documentation is available in the docs/ directory:
- TRAY_APPLICATION.md - Complete tray app guide
- TRAY_SETUP_GUIDE.md - Platform-specific setup
- STATEFUL_SESSIONS.md - Server session management
- MACOS_FORK_SAFETY_FIX.md - macOS compatibility
- DAEMON_MODE_SUMMARY.md - Background operations
๐ค Contributing
We welcome contributions! Please follow these steps:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Development Guidelines
- Follow PEP 8 style guidelines
- Add tests for new features
- Update documentation as needed
- Ensure cross-platform compatibility
๐ License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
๐ Support
- Documentation: Check the
docs/directory for detailed guides - Issues: Report bugs and request features on GitHub Issues
- Discussions: Join community discussions on GitHub Discussions
๐ง Troubleshooting
Common Issues
macOS: "Fork Safety" Errors
If you encounter fork safety errors on macOS, they have been automatically resolved in version 0.1.10+. The client now uses fork-safe daemon mode for GUI applications.
Tray Icon Not Appearing
- Linux: Ensure your desktop environment supports system tray icons
- Windows: Check if system tray icons are enabled in taskbar settings
- macOS: The icon should appear in the menu bar (top-right area)
Command Not Found
If elitea-mcp command is not found:
# For pipx installations
pipx ensurepath
source ~/.bashrc # or ~/.zprofile for zsh
# For pip installations
pip install --user elitea-mcp
export PATH="$PATH:$HOME/.local/bin"
Configuration Issues
# Reset configuration
rm -rf ~/.config/elitea-mcp-client # Linux
rm -rf ~/Library/Application\ Support/elitea-mcp-client # macOS
# Then run: elitea-mcp bootstrap
Getting Help
- Check the relevant documentation in
docs/ - Search existing GitHub Issues
- Create a new issue with:
- Your operating system and version
- Python version (
python --version) - Full error message and traceback
- Steps to reproduce the issue
๐ Changelog
Version 0.1.10 (Latest)
- โ System Tray Application - Complete GUI interface with context menus
- โ macOS Fork Safety Fix - Resolved all macOS GUI compatibility issues
- โ Daemon Mode - Background server operation with PID management
- โ Cross-Platform Support - Full Windows, macOS, and Linux compatibility
- โ Auto-Start Integration - System-level startup scripts and services
- โ Enhanced Error Handling - Comprehensive logging and recovery mechanisms
- โ Configuration Management - File-based config with GUI and CLI access
- โ Production Ready - Stable release with comprehensive testing
Previous Versions
- 0.1.9 - Added basic tray functionality
- 0.1.8 - Improved server management
- 0.1.7 - Enhanced CLI interface
- 0.1.6 - Initial PyPI release
Made with โค๏ธ by the Project EliteA Team
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 elitea_mcp-0.1.33.tar.gz.
File metadata
- Download URL: elitea_mcp-0.1.33.tar.gz
- Upload date:
- Size: 65.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
27cb68c09cbefb90a9aac2c6d18d4a6299c2c317db57f37f135022f6fd9c7e69
|
|
| MD5 |
ce5de22f15d074b2fd2c4839f651889b
|
|
| BLAKE2b-256 |
9943e9e1a401efd9c65225a969236f3c5979460f8c26f28cd4bbcd7e1b6f65e8
|
File details
Details for the file elitea_mcp-0.1.33-py3-none-any.whl.
File metadata
- Download URL: elitea_mcp-0.1.33-py3-none-any.whl
- Upload date:
- Size: 51.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5644e2a660b8ca84df663457a2b4a3a59a909d321b7ca8d9b95ee09824389a64
|
|
| MD5 |
c4ac6f664f1dd641f5955d2465ecdb2b
|
|
| BLAKE2b-256 |
3ec06df6971beec2f8facc0d71fd96c38e266ec34978be5e60fa9885c427dc14
|