Skip to main content
Glama
README.md
# MCP Connection Hub

A unified Model Context Protocol Gateway that provides a central connection point for AI tools and services.

## Overview

MCP Connection Hub acts as a bridge between Large Language Model interfaces (like OpenWebUI) and various tools and services. It provides:

- A unified OpenAI-compatible API endpoint
- Support for synchronous and asynchronous tool execution
- A pluggable architecture for easy tool integration
- Comprehensive job management for long-running operations
- Command-line and web-based administration interfaces

## Key Features

- **OpenAI API Compatibility**: Works seamlessly with OpenWebUI and other LLM interfaces
- **Tool Registry**: Easy registration and discovery of tool capabilities
- **Job System**: Manage long-running operations with progress tracking
- **Configuration Management**: Centralized settings for all system components
- **Administration Interfaces**: Both CLI and web-based management tools

## Project Structure

```
MCPConnectionHub/
├── app/                    # Main application code
│   ├── api/                # API endpoints and routes
│   ├── cli/                # Command-line interface
│   ├── core/               # Core system components
│   ├── db/                 # Database models and operations
│   └── tools/              # Tool implementations
├── docs/                   # Documentation
└── docker-compose.yml      # Docker configuration
```

## Installation & Setup

(Installation instructions will be added once the initial development is complete)

## Configuration

The system can be configured through:
- Environment variables
- Configuration files
- Database settings (for persistent configuration)

## Usage

### Command Line Interface

The system includes a comprehensive CLI for administration:

```bash
# Show help
./mcp-cli --help

# List available tools
./mcp-cli tool list

# Check system status
./mcp-cli system status

# View configuration
./mcp-cli config get
```

See the [CLI Quick Start Guide](docs/cli_quick_start.md) for more information.

### API Usage

(API usage instructions will be added as the system is developed)

## Development Status

This project is currently under active development. See the PROJECT_PROGRESS.md file for current status.