A Multi-Client Proxy (MCP) for various LLMs with failover and flexible response formats.
Project description
Multi-Client Proxy (MCP) LLM Client
The Multi-Client Proxy (MCP) LLM Client is a robust and flexible Python library designed to streamline your interactions with various Large Language Models (LLMs). It provides a unified interface to popular LLMs like Google Gemini, OpenAI ChatGPT, and Perplexity AI, with a built-in failover mechanism based on your defined priority. Additionally, it offers a versatile "Custom LLM" client, allowing you to seamlessly integrate any other LLM, whether it's a locally deployed model or another third-party service, by simply providing its API endpoint and key.
This client is built with production-grade considerations in mind, emphasizing modularity, secure API key management via environment variables, and comprehensive error handling.
โจ Features
- Multi-LLM Support: Connects to Google Gemini, OpenAI ChatGPT, Perplexity AI, and any custom LLM.
- Priority-Based Failover: Define a custom priority order for LLM providers. If a primary service fails or is unreachable, the client automatically attempts the next one in your list.
- Configurable Response Format: Request responses in plain text or structured JSON format, allowing for flexible integration into various applications.
- Secure API Key Management: All sensitive API keys are loaded securely from environment variables, ensuring your credentials are not hardcoded.
- Extensible Architecture: Designed with an abstract base class (LLMClient), making it easy to add support for new LLM providers in the future.
- Production-Grade Code: Features modular design, comprehensive error handling, and informative logging for better maintainability and debugging.
- Custom LLM Integration: A generic client to interact with any LLM that exposes an HTTP API, perfect for local models or less common third-party services.
๐ Folder Structure
The project is organized into a clear and logical folder structure:
.
โโโ README.md
โโโ examples/
โ โโโ run_client.py
โโโ mcp_client/
โ โโโ clients/
โ โ โโโ __init__.py
โ โ โโโ gemini_client.py # Google Gemini client implementation
โ โ โโโ chatgpt_client.py # OpenAI ChatGPT client implementation
โ โ โโโ perplexity_client.py # Perplexity AI client implementation
โ โ โโโ custom_llm_client.py # Generic client for any custom/local LLM
โ โโโ __init__.py
โ โโโ base_client.py # Abstract Base Class for all LLM clients
โ โโโ manager.py # Main Multi-Client Proxy logic and example usage
โโโ .env.example # Example file for environment variables
โโโ requirements.txt # Python dependencies
โโโ LICENSE # MIT License file
โโโ .gitignore # Git ignore file for common exclusions
๐ Getting Started
Follow these steps to set up and run the MCP LLM Client.
Prerequisites
- Python 3.8+
pip(Python package installer)
Installation Steps
1. Clone the repository:
git clone https://github.com/PrashantHalaki/mcp_llm_client.git
cd mcp-llm-client
2. Install dependencies:
The project uses google-generativeai, openai, and requests. You can install them using the provided requirements.txt file:
pip install -r requirements.txt
Configuration
API keys and LLM priority are managed via environment variables for security and flexibility.
1. Required API Keys
GEMINI_API_KEY="YOUR_GOOGLE_GEMINI_API_KEY"
OPENAI_API_KEY="YOUR_OPENAI_API_KEY"
PERPLEXITY_API_KEY="YOUR_PERPLEXITY_API_KEY"
2. Optional: Environment Variables
CUSTOM_LLM_URL="http://localhost:5000/generate" # Replace with your custom LLM's API endpoint
CUSTOM_LLM_API_KEY="YOUR_OPTIONAL_CUSTOM_LLM_API_KEY" # Only if your custom LLM requires one
GEMINI_MODEL="YOUR_GEMINI_MODEL" # Only if you want to use model other than gemini-1.5-flash
OPENAI_MODEL="YOUR_OPEN_AI_MODEL" # Only if you want to use model other than gpt-3.5-turbo
PERPLEXITY_MODEL="YOUR_PERPLEXITY_MODEL" # Only if you want to use model other than sonar-pro
3. Define the priority order for LLM clients (comma-separated, case-insensitive)
Available clients: gemini, chatgpt, perplexity, custom
Example: gemini,chatgpt,custom,perplexity (Gemini first, then ChatGPT, etc.)
LLM_PRIORITY="gemini,chatgpt,custom,perplexity"
LLM_PRIORITY: This variable dictates the order in which the MCP client attempts to connect to the LLMs. If the first one fails, it moves to the next. If this variable is not set, the default order is gemini,chatgpt,perplexity,custom.
If an API key for a specific service is not set, that client will issue a warning and might not function, but the MCPClient will still attempt to use the next available client in the priority list.
Load environment variables (optional, but recommended for local development):
While the client directly reads from os.getenv(), for local development, you might want to use a library like python-dotenv to automatically load variables from your .env file.
pip install python-dotenv
Then, at the top of your manager.py (or any entry point), add:
from dotenv import load_dotenv
load_dotenv() # This will load variables from .env file
๐ก Usage
The manager.py file contains an example of how to instantiate and use the MCPClient.
1. Basic Text Generation
from mcp_client import MCPClient
import os
# Initialize MCPClient. It will read LLM_PRIORITY from environment.
# If LLM_PRIORITY is not set, it defaults to "gemini,chatgpt,perplexity,custom".
mcp_client = MCPClient(priority_order=os.getenv("LLM_PRIORITY"))
prompt = "What is the capital of France?"
response_text, client_name = mcp_client.generate_response(prompt, response_format="text")
if response_text:
print(f"Response from {client_name}:")
print(response_text)
else:
print("Failed to get a response from any LLM client.")
2. JSON Response Generation
You can request structured JSON output. The client will instruct the LLM to return JSON, and for compatible models (like certain ChatGPT versions), it will use native JSON mode.
from mcp_client import MCPClient
import os
import json
mcp_client = MCPClient(priority_order=os.getenv("LLM_PRIORITY"))
json_prompt = "Tell me about the Eiffel Tower. Provide the response as a JSON object with keys 'name', 'location', 'height_meters', and 'fun_fact'."
response_json, client_name_json = mcp_client.generate_response(json_prompt, response_format="json")
if response_json:
print(f"Response from {client_name_json} (JSON):")
try: # For pretty printing the JSON string
parsed_json = json.loads(response_json)
print(json.dumps(parsed_json, indent=2))
except json.JSONDecodeError:
print(response_json) # Print raw if parsing failed
else:
print("Failed to get a JSON response from any LLM client.")
3. Passing Additional Parameters
You can pass additional keyword arguments (**kwargs) to the underlying LLM API calls. For example, to control creativity with temperature:
from mcp_client import MCPClient
import os
mcp_client = MCPClient(priority_order=os.getenv("LLM_PRIORITY"))
poem_prompt = "Write a short poem about a cat."
# Pass temperature to make the response more creative
response_poem, client_name_poem = mcp_client.generate_response(poem_prompt, response_format="text", temperature=0.7)
if response_poem:
print(f"Response from {client_name_poem}:")
print(response_poem)
else:
print("Failed to get a response for the poem from any LLM client.")
๐ค Contributing
Contributions are welcome! If you have suggestions for improvements, bug fixes, or new features, please open an issue or submit a pull request.
Please read our CONTRIBUTING.md guide before making any changes.
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
๐ Credits
Built with โค๏ธ by Prashant Halaki
Project details
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_llm_client_proxy-0.1.0.tar.gz.
File metadata
- Download URL: mcp_llm_client_proxy-0.1.0.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ee0b8b9919169b48e2cbef0bf8bb4e4e27e88cd9bd6e5e08c125b0687bb4141
|
|
| MD5 |
309367af73de046eb3f2aed526c12675
|
|
| BLAKE2b-256 |
47735701ce078c9e8707a1b5c0b7a7dce4a8b08d1dc8c7886ab17fe29f96aa75
|
File details
Details for the file mcp_llm_client_proxy-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mcp_llm_client_proxy-0.1.0-py3-none-any.whl
- Upload date:
- Size: 15.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25d90babf74393e2b2b401ecee833d9364044e4ac2e6d8d9caa1ffff638cbcfd
|
|
| MD5 |
cd10a35dc10caa4ced4ccd2dcc46038a
|
|
| BLAKE2b-256 |
d8b0eb91a9ba08020c26ef0a202530d346f27f99d62f01a19359d9323e4b5d57
|