doris-mcp-server 0.0.1__py3-none-any.whl

doris_mcp_server/config/__init__.py

@@ -0,0 +1,3 @@
+from .config import DB_CONFIG, MCP_SERVER_NAME, DEBUG
+
+__all__ = ["DB_CONFIG", "MCP_SERVER_NAME", "DEBUG"]

doris_mcp_server/config/config.py

@@ -0,0 +1,37 @@
+# config.py
+import os
+from dotenv import load_dotenv
+from pathlib import Path
+import shutil
+
+# 确定.env路径和.env.example路径
+env_dir = Path(__file__).resolve().parent
+env_path = env_dir / ".env"
+env_example_path = env_dir / ".env.example"
+
+# 如果.env不存在，尝试从.env.example复制一份
+if not env_path.exists():
+    if env_example_path.exists():
+        shutil.copy(env_example_path, env_path)
+        print(f"未找到 .env 文件，已自动从 .env.example 创建 {env_path}")
+        print(f"请根据实际情况编辑 {env_path}，填写正确的数据库连接信息。")
+    else:
+        raise FileNotFoundError(
+            f"❌ 配置文件 {env_path} 不存在，且找不到示例文件 {env_example_path}。\n"
+            f"请手动创建 .env 文件或联系开发者提供模板。"
+        )
+
+# 加载.env
+load_dotenv(dotenv_path=env_path)
+
+# 读取配置项
+DB_CONFIG = {
+    "host": os.getenv("DB_HOST", "localhost"),
+    "port": int(os.getenv("DB_PORT", 9030)),
+    "user": os.getenv("DB_USER", "root"),
+    "password": os.getenv("DB_PASSWORD", ""),
+    "database": os.getenv("DB_NAME", ""),
+}
+
+MCP_SERVER_NAME = os.getenv("MCP_SERVER_NAME", "DorisAnalytics")
+DEBUG = os.getenv("DEBUG", "false").lower() in ["1", "true", "yes"]

doris_mcp_server/db/__init__.py

@@ -0,0 +1,4 @@
+from .db import DorisConnector
+from .tools import run_select_query, preview_table, describe_table,list_all_tables
+
+__all__ = [DorisConnector, run_select_query, preview_table, describe_table, list_all_tables]

doris_mcp_server/db/db.py

@@ -0,0 +1,57 @@
+import pymysql
+from pymysql.cursors import DictCursor
+from doris_mcp_server.config import DB_CONFIG
+
+
+class DorisConnector:
+    def __init__(self):
+        self.connection = None
+        self._connect()
+
+    def _connect(self):
+        try:
+            self.connection = pymysql.connect(
+                host=DB_CONFIG["host"],
+                port=DB_CONFIG["port"],
+                user=DB_CONFIG["user"],
+                password=DB_CONFIG["password"],
+                database=DB_CONFIG["database"],
+                cursorclass=DictCursor,
+                autocommit=True
+            )
+            print(f"[DorisConnector] Connected to {DB_CONFIG['host']}:{DB_CONFIG['port']}")
+        except Exception as e:
+            print(f"[DorisConnector] Connection failed: {e}")
+            raise
+
+    def close(self):
+        if self.connection:
+            self.connection.close()
+            print("[DorisConnector] Connection closed.")
+
+    def execute_query(self, sql: str) -> list[dict]:
+        if not self.connection:
+            self._connect()
+        try:
+            with self.connection.cursor() as cursor:
+                cursor.execute(sql)
+                result = cursor.fetchall()
+                return result
+        except Exception as e:
+            print(f"[DorisConnector] Query failed: {e}")
+            raise
+
+    def get_table_schema(self, table_name: str) -> list[dict]:
+        """
+        获取指定表的字段信息，包括字段名、类型、是否为空、默认值等
+        """
+        sql = f"DESCRIBE {table_name};"
+        return self.execute_query(sql)
+
+    def list_tables(self, db: str) -> list[str]:
+        """
+        获取当前数据库中所有表的列表
+        """
+        sql = f"SHOW TABLES IN {db};"
+        result = self.execute_query(sql)
+        return [row[f'Tables_in_{DB_CONFIG["database"]}'] for row in result]

doris_mcp_server/db/tools.py

@@ -0,0 +1,94 @@
+import re
+from doris_mcp_server.db import DorisConnector
+from doris_mcp_server.mcp_app import mcp
+from doris_mcp_server.config import DB_CONFIG
+
+
+
+
+def _is_safe_select(sql: str) -> bool:
+    """
+    检查 SQL 是否为安全的 SELECT 查询
+    """
+    sql = sql.strip().lower()
+    return sql.startswith("select") and not re.search(r"\b(update|delete|insert|drop|alter|create|replace|truncate)\b", sql)
+
+
+
+@mcp.tool(name="run_select_query")
+def run_select_query(sql: str) -> str:
+    """
+    执行只读 SELECT 查询并返回格式化结果。
+    """
+    if not _is_safe_select(sql):
+        return "仅允许只读 SELECT 查询，不支持修改型语句。"
+
+    db = DorisConnector()
+    try:
+        rows = db.execute_query(sql)
+        if not rows:
+            return "查询结果为空。"
+
+        headers = rows[0].keys()
+        lines = [" | ".join(headers)]
+        lines.append("-" * len(lines[0]))
+        for row in rows:
+            lines.append(" | ".join(str(row[col]) for col in headers))
+        return "\n".join(lines)
+    except Exception as e:
+        return f"查询失败: {str(e)}"
+
+
+
+@mcp.tool(name="preview_table")
+def preview_table(table_name: str) -> str:
+    """
+    预览指定表前 10 行数据。
+    """
+    try:
+        sql = f"SELECT * FROM {table_name} LIMIT 10;"
+        return run_select_query(sql)
+    except Exception as e:
+        return f"预览失败: {str(e)}"
+
+
+
+
+@mcp.tool(name="describe_table")
+def describe_table(table_name: str) -> str:
+    """
+    返回指定表的字段结构，包括字段名、类型、是否为 null、默认值和注释。
+    """
+    db = DorisConnector()
+    try:
+        schema = db.get_table_schema(table_name)
+        if not schema:
+            return f"表 `{table_name}` 不存在或无法获取结构信息。"
+
+        headers = ["Field", "Type", "Null", "Key", "Default", "Extra"]
+        lines = [" | ".join(headers)]
+        lines.append("-" * len(lines[0]))
+
+        for row in schema:
+            line = " | ".join(str(row.get(h, "")) for h in headers)
+            lines.append(line)
+
+        return "\n".join(lines)
+
+    except Exception as e:
+        return f"获取表结构失败: {str(e)}"
+
+
+
+
+@mcp.tool(name="list_all_tables")
+def list_all_tables(db_name: str = DB_CONFIG["database"]) -> str:
+    """
+    列出当前数据库的所有表。
+    """
+    db = DorisConnector()
+    try:
+        tables = db.list_tables(db_name)
+        return "\n".join(tables)
+    except Exception as e:
+        return f"无法获取表列表: {str(e)}"

doris_mcp_server/mcp_app.py

@@ -0,0 +1,7 @@
+# mcp_app.py
+from mcp.server.fastmcp import FastMCP
+from doris_mcp_server.config import MCP_SERVER_NAME
+
+
+# 实例化唯一的 MCP Server
+mcp = FastMCP(MCP_SERVER_NAME)

doris_mcp_server/prompts/__init__.py

@@ -0,0 +1,3 @@
+from .general_prompts import query_table_overview, summarize_column, groupby_analysis, trend_analysis, outlier_analysis
+
+__all__ = [query_table_overview, summarize_column, groupby_analysis, trend_analysis, outlier_analysis]

doris_mcp_server/prompts/customize_prompts.py

@@ -0,0 +1,9 @@
+from doris_mcp_server.mcp_app import mcp
+
+# 1. 自定义数据预处理提示
+@mcp.prompt()
+def customize_prompt() -> str:
+    """
+    自定义提示
+    """
+    return None

doris_mcp_server/prompts/general_prompts.py

@@ -0,0 +1,68 @@
+from doris_mcp_server.mcp_app import mcp
+from mcp.server.fastmcp.prompts import base
+
+
+
+# 1. 简单表格查询模板
+@mcp.prompt()
+def query_table_overview(table_name: str) -> str:
+    """
+    查看表格的结构和前几行数据
+    """
+    return (
+        f"请查询 `{table_name}` 表的结构信息，并展示前 10 行数据。"
+        f"\n确保格式清晰，使用表格展示内容。"
+    )
+
+@mcp.prompt(name = "table_comment_overview", description = "查看表的注释信息")
+def query_table_comment(table_name: str) -> str:
+    """
+    查看表格的注释信息
+    """
+    return f"请查询 `{table_name}` 表的注释信息，这些信息用于描述表的用途。"
+
+# 2. 汇总统计模板
+@mcp.prompt()
+def summarize_column(column: str, table: str) -> str:
+    """
+    统计某列的常见汇总信息
+    """
+    return f"请统计 `{table}` 表中 `{column}` 列的最大值、最小值、平均值、标准差与总和。"
+
+
+# 3. 分组聚合模板
+@mcp.prompt()
+def groupby_analysis(group_col: str, target_col: str, table: str) -> str:
+    """
+    对某字段进行分组聚合分析
+    """
+    return (
+        f"请对 `{table}` 表按 `{group_col}` 分组，统计每组在 `{target_col}` 上的均值与总和，"
+        f"并按总和降序排序。"
+    )
+
+
+# 4. 数据趋势分析模板（近7日、近30日）
+@mcp.prompt()
+def trend_analysis(date_col: str, metric_col: str, table: str, days: int = 7) -> str:
+    """
+    绘制最近几天某指标的趋势
+    """
+    return (
+        f"请分析 `{table}` 表中最近 {days} 天的 `{metric_col}` 变化趋势，"
+        f"日期字段为 `{date_col}`。可视化建议使用折线图。"
+    )
+
+
+# 5. 多轮对话模板：异常值分析
+@mcp.prompt()
+def outlier_analysis() -> list[base.Message]:
+    return [
+        base.UserMessage("我想分析某个表中的异常值"),
+        base.AssistantMessage("好的，请告诉我要分析哪个表，以及哪一列？"),
+        base.UserMessage("表是 user_metrics，列是 daily_usage"),
+        base.AssistantMessage(
+            "请稍等，我将检测 `user_metrics` 表中 `daily_usage` 列的异常值，"
+            "可能使用箱线图或 3σ 原则。"
+        ),
+    ]

doris_mcp_server/res/__init__.py

@@ -0,0 +1,4 @@
+from .resources import all_table_schemas
+from .resources import table_schema
+
+__all__ = [all_table_schemas, table_schema]

doris_mcp_server/res/resources.py

@@ -0,0 +1,116 @@
+from doris_mcp_server.mcp_app import mcp
+from doris_mcp_server.db import DorisConnector
+from doris_mcp_server.config import DB_CONFIG
+from typing import Optional
+
+def _get_table_schemas(db_name: str) -> dict[str, str]:
+    """
+    获取所有表的结构信息，返回一个字典：
+    {
+        "table_name": "字段名 | 类型 | 是否为空 ... \n ...",
+        ...
+    }
+    """
+    db = DorisConnector()
+    tables = db.list_tables(db_name)
+    result = {}
+
+    for table in tables:
+        try:
+            schema = db.get_table_schema(table)
+            if not schema:
+                continue
+
+            headers = ["Field", "Type", "Null", "Key", "Default", "Extra"]
+            lines = [" | ".join(headers)]
+            lines.append("-" * len(lines[0]))
+
+            for row in schema:
+                line = " | ".join(str(row.get(h, "")) for h in headers)
+                lines.append(line)
+
+            result[table] = "\n".join(lines)
+
+        except Exception as e:
+            result[table] = f"无法获取表结构: {str(e)}"
+
+    return result
+
+
+
+
+def _get_table_comments(db_name: str) -> dict[str, str]:
+    """
+    获取所有表的注释信息，返回一个字典：
+    {
+        "table_name": "表注释",
+        ...
+    }
+    """
+    db = DorisConnector()
+    sql = f"""
+    SELECT TABLE_NAME, TABLE_COMMENT
+    FROM information_schema.TABLES
+    WHERE TABLE_SCHEMA = '{db_name}'
+    """
+    try:
+        results = db.execute_query(sql)
+        return {row["TABLE_NAME"]: row["TABLE_COMMENT"] or "无注释" for row in results}
+    except Exception as e:
+        return {"error": f"无法获取表注释信息: {str(e)}"}
+    
+
+
+
+@mcp.resource("doris://schema/{db_name}")
+def all_table_schemas(db_name: str = DB_CONFIG["database"]) -> str:
+    """
+    返回指定数据库下所有表的结构。
+    """
+    schemas = _get_table_schemas(db_name)
+
+    content = []
+    for table_name, schema_text in schemas.items():
+        content.append(f"# 表: {table_name}\n{schema_text}\n")
+
+    return "\n\n".join(content)
+
+
+
+
+@mcp.resource("doris://schema/{table}")
+def table_schema(table: str) -> Optional[str]:
+    """
+    返回单个表的字段结构信息。
+    """
+    db = DorisConnector()
+    try:
+        schema = db.get_table_schema(table)
+        if not schema:
+            return f"表 `{table}` 不存在或无结构信息。"
+
+        headers = ["Field", "Type", "Null", "Key", "Default", "Extra"]
+        lines = [" | ".join(headers)]
+        lines.append("-" * len(lines[0]))
+
+        for row in schema:
+            lines.append(" | ".join(str(row.get(h, "")) for h in headers))
+
+        return f"# 表: {table}\n" + "\n".join(lines)
+
+    except Exception as e:
+        return f"无法获取表 `{table}` 的结构信息: {str(e)}"
+    
+
+
+
+@mcp.resource("doris://table-comments/{db_name}")
+def all_table_comments(db_name: str = DB_CONFIG["database"]) -> str:
+    """
+    返回指定数据库下所有表的注释信息。
+    """
+    comments = _get_table_comments(db_name)
+    content = []
+    for table_name, comment in comments.items():
+        content.append(f"- {table_name}: {comment}")
+    return "\n".join(content)

doris_mcp_server/server.py

@@ -0,0 +1,50 @@
+from doris_mcp_server.mcp_app import mcp
+from doris_mcp_server.db import tools, DorisConnector
+from doris_mcp_server.res import resources
+from doris_mcp_server.prompts import general_prompts, customize_prompts
+import traceback
+
+
+class MCPDorisServer:
+
+    def __init__(self):
+        self.server = mcp
+
+
+    def _test_db_connection(self):
+        """
+        测试数据库连接是否成功。
+        """
+        try:
+            conn = DorisConnector()
+            result = conn.execute_query("SELECT 1")
+            if result:
+                print("✅ Database connection successful.")
+            else:
+                raise Exception("Database connection test failed: please config .env file.")
+            conn.close()
+        except Exception as e:
+            print("❌ Database connection test failed.")
+            raise e
+
+
+    def run(self):
+        """
+        启动 MCP Server
+        """
+        try:
+            print("🚀 Doris MCP Server is starting...")
+            self._test_db_connection()
+            self.server.run()
+        except Exception as e:
+            print("🚨 Doris MCP Server failed to start.")
+            print(f"Error: {e}")
+            traceback.print_exc()
+
+
+def main():
+    app = MCPDorisServer()
+    app.run()
+
+if __name__ == "__main__":
+    main()

doris_mcp_server/test.py

@@ -0,0 +1,81 @@
+import asyncio
+import argparse
+import json
+from mcp import ClientSession
+from mcp.client.stdio import stdio_client
+from mcp import StdioServerParameters
+
+async def test_resources(session: ClientSession):
+    print("== 列出所有资源 ==")
+    resources = await session.list_resources()
+    for res in resources.resources:
+        print(f"- {res.uri} ({res.name})")
+
+    if resources.resources:
+        print("\n== 读取第一个资源 ==")
+        uri = resources.resources[0].uri
+        content, mime_type = await session.read_resource(uri)
+        print(f"内容类型: {mime_type}\n内容预览:\n{content[:500]}...")
+
+async def test_tools(session: ClientSession):
+    print("== 列出所有工具 ==")
+    tools = await session.list_tools()
+    for tool in tools.tools:
+        print(f"- {tool.name}: {tool.description}")
+
+    if tools.tools:
+        tool = tools.tools[0]
+        print(f"\n== 调用第一个工具：{tool.name} ==")
+
+        # 构造默认的空参数，如果需要可以在这里根据schema生成
+        args = {}
+        for key, schema in tool.inputSchema.get("properties", {}).items():
+            if schema.get("type") == "string":
+                args[key] = "test"
+            elif schema.get("type") == "integer":
+                args[key] = 1
+            elif schema.get("type") == "number":
+                args[key] = 1.0
+            elif schema.get("type") == "boolean":
+                args[key] = True
+            else:
+                args[key] = None
+
+        print(f"调用参数: {json.dumps(args)}")
+        result = await session.call_tool(tool.name, arguments=args)
+        print(f"返回结果: {result}")
+
+async def test_prompts(session: ClientSession):
+    print("== 列出所有提示词 (prompts) ==")
+    prompts = await session.list_prompts()
+    for prompt in prompts.prompts:
+        print(f"- {prompt.name}: {prompt.description}")
+
+    if prompts.prompts:
+        prompt = prompts.prompts[0]
+        print(f"\n== 获取第一个提示词：{prompt.name} ==")
+        response = await session.get_prompt(prompt.name, arguments={})
+        print("提示词返回内容:")
+        print(response)
+
+async def main():
+    parser = argparse.ArgumentParser(description="MCP Server 测试工具")
+    parser.add_argument("--server", type=str, required=True, help="Server 启动脚本路径，例如 server.py")
+    parser.add_argument("--test", type=str, required=True, choices=["resources", "tools", "prompts", "all"], help="要测试的功能")
+    args = parser.parse_args()
+
+    # 连接到 MCP Server
+    server_params = StdioServerParameters(command="python", args=[args.server])
+    async with stdio_client(server_params) as (read_stream, write_stream):
+        async with ClientSession(read_stream, write_stream) as session:
+            await session.initialize()
+
+            if args.test in ["resources", "all"]:
+                await test_resources(session)
+            if args.test in ["tools", "all"]:
+                await test_tools(session)
+            if args.test in ["prompts", "all"]:
+                await test_prompts(session)
+
+if __name__ == "__main__":
+    asyncio.run(main())

doris_mcp_server-0.0.1.dist-info/METADATA

@@ -0,0 +1,336 @@
+Metadata-Version: 2.4
+Name: doris-mcp-server
+Version: 0.0.1
+Summary: An MCP server for analytics on Apache Doris database.
+Project-URL: Homepage, https://github.com/NomotoK/doris-mcp-server
+Project-URL: Repository, https://github.com/NomotoK/doris-mcp-server
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: mcp[cli]>=1.6.0
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pyarrow>=19.0.1
+Requires-Dist: pymysql>=1.1.1
+Dynamic: license-file
+
+# **📖 Doris-MCP-Server**
+
+A lightweight **MCP server** designed for connecting to **Apache Doris** or other **MySQL compatible** database schemas, providing tools and prompts for LLM applications.
+
+This server enables LLMs and MCP clients to explore database schemas, run read-only SQL queries, and leverage pre-built analytical prompts — all through a standardized, secure MCP interface.
+
+> [!WARNING]
+> This is an early developer version of doris-mcp-server. Some functions may not operate properly and minor bugs may exist. If you have any quesions, please open an [issue](https://github.com/NomotoK/Doris-MCP-Server/issues).
+
+## **🚀 Features**
+
+### **🛠️ Tools**
+
+- Execute **read-only SQL queries** against your Doris database.
+- Perform **data analysis operations** such as retrieving yearly, monthly, and daily usage data.
+- Query metadata such as **database schemas**, **table structures**, and **resource usage**.
+
+### **🧠 Prompts**
+
+- Built-in prompt templates to assist LLMs in asking **analytics questions**.
+- Support for **user-defined** and **general-purpose** SQL analysis prompts.
+
+### **🗂️ Resources**
+
+- Expose your Doris **database schema** as **structured resources**.
+- Allow LLMs to **contextually access** table and field definitions to improve query understanding.
+
+## **📦 Installation Options**
+
+We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python environment.
+
+### **Option 1: Install via shell script**
+
+> **Recommended for server deployment**
+
+This is the easiest way to install. Please copy the `setup.sh`  file in project and run it locally. For more information please refer: [Doris MCP install guide](INSTALL.md)
+
+1. Copy the `setup.sh` to local.
+2. Make the script executable:
+
+```bash
+chmod +x setup.sh
+```
+
+3. Run the script:
+
+```bash
+./setup.sh
+```
+
+The script will automatically install the server and help you walk through database configuration.
+### **Option 2: Install via `pip`**
+
+> **Recommended for production usage**
+
+```bash
+pip install doris-mcp-server
+```
+
+✅ After installation, the command-line tool server will be available to launch the MCP server.
+
+### **Option 3: Clone the source and install manually**
+
+> **Recommended if you want to modify the server**
+
+1. Fork and clone the repository:
+
+```bash
+git clone https://github.com/YOUR_USERNAME/doris-mcp-server.git
+cd doris-mcp-server
+```
+
+1. Set up a local Python environment using [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv venv
+uv pip install -e .
+```
+
+1. Add this server to your LLM client or Run the server:
+
+```bash
+uv run server
+```
+
+### **Option 4: Install using uv directly**
+
+> **For local editable installations**
+
+```bash
+uv pip install 'git+https://github.com/YOUR_USERNAME/doris-mcp-server.git'
+```
+
+## **⚙️ Post-Installation Setup**
+
+### **Step 1: Configure `.env` file**
+
+Doris-MCP-Server uses .env file to configure database connection info. Please follow these steps to finish configuration:
+
+#### **Configure through shell script**
+
+This is the most recommended and easiest way to setup. Please refer to [Doris MCP install guide](INSTALL.md).
+
+#### **Configure manually**
+
+After installing, navigate to the `doris_mcp_server/config/` directory inside your project directory. If you are using pip, your package will be installed in Python site-packages:
+
+- **Mac/Linux:** `/Users/YOUR_USERNAME/.local/lib/python3.x/site-packages/doris_mcp_server/config/`
+
+- **Windows:** `C:\Users\YOUR_USERNAME\AppData\Local\Programs\Python\Python3x\Lib\site-packages\doris_mcp_server\config\`
+
+You can run the following command to locate pip install location:
+
+```bash
+pip show doris-mcp-server
+```
+
+You will find a `.env.example` file:
+
+1. Copy `.env.example` to `.env`:
+
+```bash
+cp .env.example .env
+```
+
+2. Edit .env to set your **Doris** database connection information:
+
+```bash
+DB_HOST=your-doris-host
+DB_PORT=9030
+DB_USER=your-username
+DB_PASSWORD=your-password
+DB_NAME=your-database
+
+MCP_SERVER_NAME=DorisAnalytics
+DEBUG=false
+```
+
+> [!NOTE]
+> If `.env `is missing, the server will attempt to auto-create it from `.env.example` but you must manually fill in correct credentials.
+
+### **Step 2: Configure MCP Client**
+
+To connect this server to an MCP-compatible client (e.g., Claude Desktop, CherryStudio, Cline), you need to modify your MCP client configuration JSON.
+
+Example if you are using CherryStudio:
+
+- name: doris-mcp-server
+- type: stdio
+- command: absolute/path/to/your/uv
+- arguments:
+
+```bash
+--directory
+/Users/hailin/dev/Doris-MCP-Server
+run
+server
+```
+
+
+Example if you are installing with pip (`mcp_setting.json`):
+
+```json
+{
+  "mcpServers": {
+    "DorisAnalytics": {
+      "command": "server",
+      "args": [],
+      "transportType": "stdio"
+    }
+  }
+}
+```
+
+Alternatively, if you prefer a more robust form:
+
+```json
+{
+  "mcpServers": {
+    "DorisAnalytics": {
+      "command": "python",
+      "args": ["-m", "doris_mcp_server.server"],
+      "transportType": "stdio"
+    }
+  }
+}
+```
+
+If you are installing with source code or using `setup.sh`:
+
+```json
+{
+"mcpServers": {
+	"DorisAnalytics": {
+		"disabled": false,
+		"timeout": 60,
+		"command": "absolute/path/to/uv",
+		"args": [
+			"--directory",
+			"absolute/path/to/mcp/server",
+			"run",
+			"server"
+		],
+		"transportType": "stdio"
+		}
+	}
+
+}
+```
+
+For more information on how to configure your client, please refer to :
+
+[For Server Developers - Model Context Protocol - Claude](https://modelcontextprotocol.io/quickstart/server)
+
+
+[配置和使用 MCP | CherryStudio](https://docs.cherry-ai.com/advanced-basic/mcp/config)
+
+✅ Now your LLM client will discover Doris Analytics tools, prompts, and resources through the MCP server.
+
+---
+
+## **🖥️ Usage**
+
+### **Testing MCP server**
+
+Before you start, you can run the `test.py` in the project `src/doris-mcp-server` directory to directly call the MCP Server functional interface to test resources, tools, etc. without using LLM (such as Claude, GPT, etc. models). You can control what functions to test by passing arguments through the command line.
+
+Test all resources exposed by the server:
+
+```bash
+python test.py --server server.py --test resources
+```
+
+or test all the tools provided by the server:
+
+```bash
+python test.py --server server.py --test tools
+```
+
+or test all functions of resources, tools, and prompt words at one time:
+
+```bash
+python test.py --server server.py --test all
+```
+
+### **Testing Database connection and run server**
+
+Launch the MCP server by running the command:
+
+```bash
+server
+```
+
+Or manually:
+
+```bash
+python -m doris_mcp_server.server
+```
+
+The server immediately attempts to connect to the database. If the connection is successful, after startup, you should see:
+
+```bash
+🚀 Doris MCP Server is starting...
+[DorisConnector] Connected to 127.0.0.1:9030
+✅ Database connection successful.
+[DorisConnector] Connection closed.
+```
+
+You can now use the tools and prompts inside your MCP client.
+
+## **📚 Project Structure Overview**
+
+```bash
+src/
+└── doris_mcp_server/
+	├── config/             # Configuration files
+	│   ├── __init__.py
+	│   ├── config.py       # Loads environment variables
+	│   ├── .env.example    # Environment variables template
+	│   └── .env            # Stores your database credentials
+	│
+	├── db/                 # Database interaction logic
+	│   ├── __init__.py
+	│   ├── db.py           # Doris database connection class
+	│   └── tools.py        # SQL query execution tools
+	│
+	├── res/                # Resource definitions (e.g., schemas)
+	│   ├── __init__.py
+	│   └── resources.py
+	│
+	├── prompts/            # Prebuilt prompt templates
+	│   ├── __init__.py
+	│   ├── general_prompts.py
+	│   └── customize_prompts.py
+	│
+	├── server.py           # Main entry point to start the MCP server
+	├── mcp_app.py          # MCP object
+	└── test.py             # Unit test script
+README.md                   # Documentation
+INSTALL.md                  # Installation guide
+LISENCE                     # Lisence
+setup.sh                    # Auto setup wizard
+pyproject.toml              # Project build configuration
+.gitignore                  # Git ignore settings
+```
+
+## **📜 License**
+
+This project is licensed under the [MIT License](LICENSE).
+
+## **🌟Acknowledgements**
+
+- Built using the [MCP Python SDK](https://pypi.org/project/mcp/).
+- Inspired by MCP official examples and best practices.
+
+---
+
+## **🤝 Contributions**
+
+Contributions are welcome! Feel free to open issues or submit pull requests.

doris_mcp_server-0.0.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+doris_mcp_server/mcp_app.py,sha256=foC-XmqvnvQAkr907NKR2XUfI24h2YXga12j-Tsyn1g,169
+doris_mcp_server/server.py,sha256=cC1ZzmAAFQ9CUxyzCkgorb06gSSclfswGbG67XYYIuc,1301
+doris_mcp_server/test.py,sha256=hFF3pAm90qyL4NwopL32VUJvveB0XEYrxcVh00FA8HQ,3154
+doris_mcp_server/config/__init__.py,sha256=J374zeXcbI6HL_uRiXeEfCYRDfAL_tAGCoVowl2yjDg,106
+doris_mcp_server/config/config.py,sha256=7z_gBIVxlJJP9AdA2kj8e8ri0BmBb9dsv4MzXCUxmlY,1270
+doris_mcp_server/db/__init__.py,sha256=ZxL_6uwaeh4fk3U_WQjHByqNXsOD3XMaEKgGT2jyf2k,207
+doris_mcp_server/db/db.py,sha256=-aFcas-DOb14WwaOVXcDM47SGwPGS2M0o25Eg1RQCY4,1875
+doris_mcp_server/db/tools.py,sha256=BPRbFCjeqvf36REJjgOKJVCqJ12XrkGBzkL59CzRp5Q,2539
+doris_mcp_server/prompts/__init__.py,sha256=e_7tmLCopR6D64s_6Jq8te_IZzMbrT_RnIokdKuHjdQ,223
+doris_mcp_server/prompts/customize_prompts.py,sha256=W6Y4DZuIimV57YK_5wg5hN8d60S7IuH7gOqrADA_pVY,174
+doris_mcp_server/prompts/general_prompts.py,sha256=piMc4mO20g6UBIFtIZIM4y6tMfd4mxDEGa4_gN09rpA,2240
+doris_mcp_server/res/__init__.py,sha256=U4NpXKN4pvCg0l3Wq9419ILQSQrIci0UQk4uz75dSGo,121
+doris_mcp_server/res/resources.py,sha256=Te3clplmUj4_fGt2YHzFurpPltBCduf3Ti69zs6zGg8,3168
+doris_mcp_server-0.0.1.dist-info/licenses/LICENSE,sha256=-I3M16s57QqzUxQs9Ai0nXVmDv9q6STMtca5uJNRN44,1067
+doris_mcp_server-0.0.1.dist-info/METADATA,sha256=lTWVg5vlf8nQeipzF6i9aXiP9GGAWEquRP2CkEPuNjw,9140
+doris_mcp_server-0.0.1.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
+doris_mcp_server-0.0.1.dist-info/entry_points.txt,sha256=i6FD1xPvTFUklYP1i5EhiL6Xj6yGykpXmCnvmA-YDJQ,56
+doris_mcp_server-0.0.1.dist-info/top_level.txt,sha256=dB0Q4-0nUE-o5baiKfwFXE4pVR4q0vDsdGc9XQh2YrE,17
+doris_mcp_server-0.0.1.dist-info/RECORD,,

doris_mcp_server-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

doris_mcp_server-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+server = doris_mcp_server.server:main

doris_mcp_server-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hailin Xie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

doris_mcp_server-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+doris_mcp_server