# mcp-olap

**Repository Path**: dongzhangust/mcp-olap

## Basic Information

- **Project Name**: mcp-olap
- **Description**: An MCP server for OLAP engines such as ClickHouse and Doris.
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-11-12
- **Last Updated**: 2025-11-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mcp-olap

An MCP server for OLAP engines such as ClickHouse and Doris.

## Prerequisites

* Python >= 3.12
* clickhouse-connect >= 0.9.1
* fastmcp >= 2.12.3
* pydoris >= 1.1.0
* pytest >= 8.4.2
* UV package manager
* Git

## Setting Up Your Development Environment

1.Fork and clone the repository
```shell
  git clone https://gitee.com/fusion-insight-team/mcp-olap.git && cd mcp-olap
```
2.Install UV (if not already installed)
```shell
  pip3 install uv 
```
3.Generate a Virtual Environment Using the uv Command
```shell
  uv sync && source .venv/bin/activate
```

## Configuration

Create a `.env` file in the project’s root directory and add the following contents:
```dotenv
CLICKHOUSE_HOST=localhost
CLICKHOUSE_PORT=8123
CLICKHOUSE_USER=clickhouse
CLICKHOUSE_PASSWORD=clickhouse
CLICKHOUSE_MCP_SERVER_TRANSPORT=http
CLICKHOUSE_MCP_BIND_PORT=8288
```

## Running the Server

```shell
  /bin/bash ./start_mcp_olap.sh
```

## Running Tests

```shell
  # todo
```

## Check Styles

```shell
  # Format code
  uv run ruff format mcp_olap/ tests/

  # Check linting
  uv run ruff check mcp_olap/ tests/

  # Fix linting issues automatically
  uv run ruff check --fix mcp_olap/ tests/
```