An open-source client for the Model Context Protocol
Project description
MCP Open Client
A NiceGUI-based chat application for Claude and other OpenAI-compatible APIs. Version 0.1.1.
Features
- Chat interface for Claude and other OpenAI-compatible APIs
- Support for custom tools and function calling
- Conversation management
- Settings customization
- Dark mode support
Installation
You can install the latest version of the package from PyPI:
pip install mcp-open-client
To install a specific version:
pip install mcp-open-client==0.1.1
Or install the latest development version directly from GitHub:
pip install git+https://github.com/alejoair/mcp-open-client.git
For development installation:
# Clone the repository
git clone https://github.com/alejoair/mcp-open-client.git
cd mcp-open-client
# Install in development mode
python install_dev.py
Usage
After installation, you can run the application with:
mcp-open-client [--port PORT] [--host HOST]
Command-line options:
--port PORT: Specify the port to run the application on (default: 8081)--host HOST: Specify the host to run the application on (default: 0.0.0.0)
Or from Python:
from mcp_open_client.main import main
if __name__ == "__main__":
main(port=8081, host="0.0.0.0")
Configuration
The application stores its configuration in the user's home directory at ~/mcp-open-client/config/.
The following files are created:
user_settings.json: Contains user settings like API key, model, etc.user_tools.json: Contains custom tools created by the useruser_theme.css: Contains the user's custom CSS theme (created on first installation)
Theme Customization
During the first installation, the default theme CSS file is copied to your configuration directory. You can customize the application's appearance by editing the user_theme.css file located at ~/mcp-open-client/config/user_theme.css.
API Configuration
To use the application, you need to configure your API key in the settings. The application supports:
- OpenAI API (ChatGPT, GPT-4)
- Anthropic API (Claude)
- Any OpenAI-compatible API endpoint
Package Structure
mcp_open_client/
├── __init__.py # Package initialization with version info
├── main.py # Main entry point
├── api.py # API client implementation
├── state.py # Application state management
├── ui/ # UI components
│ ├── __init__.py # UI package initialization
│ ├── common.py # Common UI elements
│ ├── chat.py # Chat interface
│ ├── settings.py # Settings interface
│ └── tools.py # Tools interface
├── assets/ # Static assets
│ └── favicon # Application favicon
└── settings/ # Default settings
├── default_settings.json # Default application settings
└── default_tools.json # Default tools configuration
Development
To set up the development environment:
- Clone the repository:
git clone https://github.com/alejoair/mcp-open-client.git - Navigate to the project directory:
cd mcp-open-client - Install in development mode:
python install_dev.py - Run the application:
python -m mcp_open_client.main
Testing
To verify the package installation:
python test_import.py
API Reference
Main Module
from mcp_open_client.main import main
# Run the application with custom settings
main(port=8080, host="127.0.0.1")
State Module
from mcp_open_client.state import State
# Access the application state
state = State()
API Module
from mcp_open_client.api import ChatAPI
# Create a chat API instance
api = ChatAPI()
License
MIT License
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
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_open_client-0.1.12.tar.gz.
File metadata
- Download URL: mcp_open_client-0.1.12.tar.gz
- Upload date:
- Size: 48.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d495b081a7ce51499891b3990a9e33d96f2a71e564409866a87894a267eb14b
|
|
| MD5 |
1dd52b03f306c933f3c71130a3ff5296
|
|
| BLAKE2b-256 |
3109471a2017a2ba94b741156a77a99736ceccc5d91f061606a420e924d8adb8
|
File details
Details for the file mcp_open_client-0.1.12-py3-none-any.whl.
File metadata
- Download URL: mcp_open_client-0.1.12-py3-none-any.whl
- Upload date:
- Size: 58.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7ed880553874e9cd57e927c7a1fc4929e7c90b7c70761d95763734a0b8d4a4a8
|
|
| MD5 |
115baf0e34911991e4666710a3eab3cf
|
|
| BLAKE2b-256 |
d925472fab9c28acbff596a7a18f82f9f57b49051e66bd886a3998b194fa06d6
|