StarRocks MCP Server

ทางการ

โต้ตอบกับ StarRocks

GitHub
178

เอกสาร

MseeP.ai Security Assessment Badge

เซิร์ฟเวอร์ MCP อย่างเป็นทางการของ StarRocks

เซิร์ฟเวอร์ StarRocks MCP ทำหน้าที่เป็นสะพานเชื่อมระหว่างผู้ช่วย AI และฐานข้อมูล StarRocks ช่วยให้สามารถดำเนินการ SQL โดยตรง สำรวจฐานข้อมูล แสดงภาพข้อมูลผ่านแผนภูมิ และเรียกดูภาพรวมของ schema/ข้อมูลโดยละเอียด โดยไม่ต้องตั้งค่าฝั่งไคลเอ็นต์ที่ซับซ้อน

StarRocks Server MCP server

คุณสมบัติ

  • การดำเนินการ SQL โดยตรง: รันคำสั่ง SELECT (read_query) และคำสั่ง DDL/DML (write_query)
  • การสำรวจฐานข้อมูล: แสดงรายการฐานข้อมูลและตาราง เรียกดู schema ของตาราง (ทรัพยากร starrocks://)
  • ข้อมูลระบบ: เข้าถึงเมตริกและสถานะภายในของ StarRocks ผ่านเส้นทางทรัพยากร proc://
  • ภาพรวมโดยละเอียด: รับสรุปที่ครอบคลุมของตาราง (table_overview) หรือฐานข้อมูลทั้งหมด (db_overview) รวมถึงคำจำกัดความของคอลัมน์ จำนวนแถว และข้อมูลตัวอย่าง
  • การแสดงภาพข้อมูล: ดำเนินการคิวรีและสร้างแผนภูมิ Plotly โดยตรงจากผลลัพธ์ (query_and_plotly_chart)
  • แคชอัจฉริยะ: ภาพรวมของตารางและฐานข้อมูลถูกแคชในหน่วยความจำเพื่อเพิ่มความเร็วในการร้องขอซ้ำ สามารถข้ามแคชได้เมื่อจำเป็น
  • การกำหนดค่าที่ยืดหยุ่น: ตั้งค่ารายละเอียดการเชื่อมต่อและพฤติกรรมผ่านตัวแปรสภาพแวดล้อม

ข้อกำหนดเบื้องต้น

  • Python 3.11 หรือใหม่กว่า
  • คลัสเตอร์ StarRocks ที่เข้าถึงได้ (บริการ FE) โดยค่าเริ่มต้นเซิร์ฟเวอร์จะเชื่อมต่อกับ localhost:9030 ผ่านโปรโตคอล MySQL
  • uv — เครื่องมือจัดการแพ็คเกจและโปรเจกต์ Python ที่รวดเร็ว (ตัวแทนสมัยใหม่ของ pip + virtualenv) จาก Astral โปรเจกต์นี้ใช้ uv เพื่อแก้ไขการพึ่งพา สร้างสภาพแวดล้อมเสมือน และเปิดใช้เซิร์ฟเวอร์ คำสั่ง uv run ตลอด README นี้จะสร้างสภาพแวดล้อมแบบแยกและติดตั้งการพึ่งพาที่จำเป็นโดยอัตโนมัติเมื่อใช้งานครั้งแรก ดังนั้นจึงไม่จำเป็นต้องมีขั้นตอน pip install ด้วยตนเอง

การติดตั้ง uv

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# Or via Homebrew / pipx / pip
brew install uv
# pipx install uv
# pip install uv

ดู คู่มือการติดตั้ง uv อย่างเป็นทางการ สำหรับตัวเลือกอื่นๆ หลังจากติดตั้งแล้ว ตรวจสอบว่าอยู่ใน PATH ของคุณ:

uv --version

การติดตั้ง

โดยทั่วไปคุณไม่จำเป็นต้องติดตั้งแพ็คเกจด้วยตนเอง — โฮสต์ MCP จะเปิดใช้ผ่าน uv (ดู การกำหนดค่า ด้านล่าง) uv จะดึงแพ็คเกจและการพึ่งพาตามต้องการ

หากต้องการรันโดยตรงเพื่อการทดสอบหรือพัฒนา:

# Run the published package in a throwaway environment
uv run --with mcp-server-starrocks mcp-server-starrocks --help

# Or, from a local checkout of this repository
git clone https://github.com/starrocks/mcp-server-starrocks.git
cd mcp-server-starrocks
uv sync                      # create the virtual environment and install dependencies
uv run mcp-server-starrocks --help

การกำหนดค่า

โดยทั่วไปเซิร์ฟเวอร์ MCP จะทำงานผ่านโฮสต์ MCP การกำหนดค่าจะถูกส่งไปยังโฮสต์ โดยระบุวิธีการเปิดใช้กระบวนการเซิร์ฟเวอร์ StarRocks MCP

การใช้ Streamable HTTP (แนะนำ):

เพื่อเริ่มเซิร์ฟเวอร์ในโหมด Streamable HTTP:

ขั้นแรกทดสอบว่าการเชื่อมต่อกับ StarRocks ใช้ได้ (9030 คือพอร์ตโปรโตคอล MySQL ของ StarRocks ไม่ใช่พอร์ตเซิร์ฟเวอร์ HTTP):

$ STARROCKS_URL=root:@localhost:9030 uv run mcp-server-starrocks --test

เริ่มเซิร์ฟเวอร์:

uv run mcp-server-starrocks --mode streamable-http --port 8000

จากนั้นกำหนดค่า MCP ดังนี้:

{
  "mcpServers": {
    "mcp-server-starrocks": {
      "url": "http://localhost:8000/mcp"
    }
  }
}

การใช้ uv กับแพ็คเกจที่ติดตั้ง (ตัวแปรสภาพแวดล้อมแยก):

{
  "mcpServers": {
    "mcp-server-starrocks": {
      "command": "uv",
      "args": ["run", "--with", "mcp-server-starrocks", "mcp-server-starrocks"],
      "env": {
        "STARROCKS_HOST": "default localhost",
        "STARROCKS_PORT": "default 9030",
        "STARROCKS_USER": "default root",
        "STARROCKS_PASSWORD": "default empty",
        "STARROCKS_DB": "default empty"
      }
    }
  }
}

การใช้ uv กับแพ็คเกจที่ติดตั้ง (URL การเชื่อมต่อ):

{
  "mcpServers": {
    "mcp-server-starrocks": {
      "command": "uv",
      "args": ["run", "--with", "mcp-server-starrocks", "mcp-server-starrocks"],
      "env": {
        "STARROCKS_URL": "root:password@localhost:9030/my_database"
      }
    }
  }
}

การใช้ uv กับไดเรกทอรีในเครื่อง (สำหรับการพัฒนา):

{
  "mcpServers": {
    "mcp-server-starrocks": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/mcp-server-starrocks", // <-- Update this path
        "run",
        "mcp-server-starrocks"
      ],
      "env": {
        "STARROCKS_HOST": "default localhost",
        "STARROCKS_PORT": "default 9030",
        "STARROCKS_USER": "default root",
        "STARROCKS_PASSWORD": "default empty",
        "STARROCKS_DB": "default empty"
      }
    }
  }
}

การใช้ uv กับไดเรกทอรีในเครื่องและ URL การเชื่อมต่อ:

{
  "mcpServers": {
    "mcp-server-starrocks": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/mcp-server-starrocks", // <-- Update this path
        "run",
        "mcp-server-starrocks"
      ],
      "env": {
        "STARROCKS_URL": "root:password@localhost:9030/my_database"
      }
    }
  }
}

อาร์กิวเมนต์บรรทัดคำสั่ง:

เซิร์ฟเวอร์รองรับอาร์กิวเมนต์บรรทัดคำสั่งต่อไปนี้:

uv run mcp-server-starrocks --help
  • --mode {stdio,sse,http,streamable-http}: โหมดการขนส่ง (ค่าเริ่มต้น: stdio หรือตัวแปรสภาพแวดล้อม MCP_TRANSPORT_MODE)
  • --host HOST: โฮสต์เซิร์ฟเวอร์สำหรับโหมด HTTP (ค่าเริ่มต้น: localhost)
  • --port PORT: พอร์ตเซิร์ฟเวอร์สำหรับโหมด HTTP
  • --test: รันในโหมดทดสอบเพื่อตรวจสอบฟังก์ชันการทำงาน

ตัวอย่าง:

# Start in streamable HTTP mode on custom host/port
uv run mcp-server-starrocks --mode streamable-http --host 0.0.0.0 --port 8080

# Start in stdio mode (default)
uv run mcp-server-starrocks --mode stdio

# Run test mode
uv run mcp-server-starrocks --test
  • ฟิลด์ url ควรชี้ไปยังปลายทาง Streamable HTTP ของเซิร์ฟเวอร์ MCP ของคุณ (ปรับโฮสต์/พอร์ตตามความจำเป็น)
  • ด้วยการกำหนดค่านี้ ไคลเอ็นต์สามารถโต้ตอบกับเซิร์ฟเวอร์โดยใช้ JSON มาตรฐานผ่านคำขอ HTTP POST ไม่จำเป็นต้องใช้ SDK พิเศษ
  • API เครื่องมือทั้งหมดรับและส่งคืน JSON มาตรฐานตามที่อธิบายไว้ข้างต้น

หมายเหตุ: โหมด sse (Server-Sent Events) เลิกใช้แล้วและไม่ได้รับการดูแลอีกต่อไป โปรดใช้โหมด Streamable HTTP สำหรับการผสานรวมใหม่ทั้งหมด

ตัวแปรสภาพแวดล้อม:

การกำหนดค่าการเชื่อมต่อ

คุณสามารถกำหนดค่าการเชื่อมต่อ StarRocks โดยใช้ตัวแปรสภาพแวดล้อมแยกหรือ URL การเชื่อมต่อเดียว:

ตัวเลือกที่ 1: ตัวแปรสภาพแวดล้อมแยก

  • STARROCKS_HOST: (ไม่บังคับ) ชื่อโฮสต์หรือที่อยู่ IP ของบริการ StarRocks FE ค่าเริ่มต้นคือ localhost
  • STARROCKS_PORT: (ไม่บังคับ) พอร์ตโปรโตคอล MySQL ของบริการ StarRocks FE ค่าเริ่มต้นคือ 9030
  • STARROCKS_USER: (ไม่บังคับ) ชื่อผู้ใช้ StarRocks ค่าเริ่มต้นคือ root
  • STARROCKS_PASSWORD: (ไม่บังคับ) รหัสผ่าน StarRocks ค่าเริ่มต้นคือสตริงว่าง
  • STARROCKS_PASSWORD_KEYCHAIN_SERVICE: (ไม่บังคับ, macOS เท่านั้น) ชื่อบริการรหัสผ่านทั่วไปที่จะใช้เมื่ออ่านรหัสผ่านจาก Keychain จะใช้เฉพาะเมื่อไม่มีรหัสผ่านที่ชัดเจนผ่าน STARROCKS_PASSWORD หรือ STARROCKS_URL
  • STARROCKS_PASSWORD_KEYCHAIN_ACCOUNT: (ไม่บังคับ, macOS เท่านั้น) ชื่อบัญชีรหัสผ่านทั่วไปที่จะใช้เมื่ออ่านรหัสผ่านจาก Keychain ค่าเริ่มต้นคือผู้ใช้ StarRocks ที่แก้ไขแล้ว
  • STARROCKS_DB: (ไม่บังคับ) ฐานข้อมูลเริ่มต้นที่จะใช้หากไม่ได้ระบุในอาร์กิวเมนต์เครื่องมือหรือ URI ทรัพยากร หากตั้งค่า การเชื่อมต่อจะพยายาม USE ฐานข้อมูลนี้ เครื่องมือเช่น table_overview และ db_overview จะใช้สิ่งนี้หากส่วนฐานข้อมูลถูกละไว้ในอาร์กิวเมนต์ ค่าเริ่มต้นคือว่างเปล่า (ไม่มีฐานข้อมูลเริ่มต้น)

ตัวเลือกที่ 2: URL การเชื่อมต่อ (มีความสำคัญเหนือกว่าตัวแปรแยก)

  • STARROCKS_URL: (ไม่บังคับ) สตริง URL การเชื่อมต่อที่มีพารามิเตอร์การเชื่อมต่อทั้งหมดในตัวแปรเดียว รูปแบบ: [<schema>://]user:password@host:port/database ส่วน schema เป็นตัวเลือก เมื่อตั้งค่าตัวแปรนี้ จะมีความสำคัญเหนือกว่าตัวแปร STARROCKS_HOST, STARROCKS_PORT, STARROCKS_USER, STARROCKS_PASSWORD และ STARROCKS_DB แต่ละตัว

    ตัวอย่าง:

ลำดับความสำคัญของรหัสผ่าน:

  • รหัสผ่านที่ฝังใน STARROCKS_URL จะชนะ รวมถึงรหัสผ่านว่างที่ชัดเจนเช่น user:@host:9030/db
  • หาก STARROCKS_URL ละเว้นรหัสผ่าน STARROCKS_PASSWORD จะถูกใช้เมื่อตั้งค่า
  • หากไม่มีการตั้งค่าแหล่งรหัสผ่านที่ชัดเจนและกำหนดค่า STARROCKS_PASSWORD_KEYCHAIN_SERVICE รหัสผ่านจะถูกอ่านจาก macOS Keychain

ตัวอย่าง macOS Keychain

จัดเก็บรหัสผ่าน:

security add-generic-password -U -a root -s mcp-server-starrocks -w 'secret'

ตรวจสอบรหัสผ่านที่จัดเก็บ:

security find-generic-password -a root -s mcp-server-starrocks -w

ใช้กับเซิร์ฟเวอร์นี้:

export STARROCKS_URL=root@localhost:9030/test_db
export STARROCKS_PASSWORD_KEYCHAIN_SERVICE=mcp-server-starrocks
export STARROCKS_PASSWORD_KEYCHAIN_ACCOUNT=root

การกำหนดค่าเพิ่มเติม

  • STARROCKS_FE_ARROW_FLIGHT_SQL_PORT: (ไม่บังคับ) พอร์ต Arrow Flight SQL ของบริการ StarRocks FE เมื่อตั้งค่า เซิร์ฟเวอร์จะเชื่อมต่อโดยใช้โปรโตคอล Arrow Flight SQL ประสิทธิภาพสูง (ผ่านไดรเวอร์ ADBC) แทนโปรโตคอล MySQL มาตรฐาน ปล่อยว่างไว้เพื่อใช้การเชื่อมต่อ MySQL เริ่มต้น โฮสต์ ผู้ใช้ และรหัสผ่านนำมาจากการตั้งค่าการเชื่อมต่อเดียวกันที่อธิบายไว้ข้างต้น

  • STARROCKS_OVERVIEW_LIMIT: (ไม่บังคับ) ขีดจำกัดอักขระ_โดยประมาณ_ สำหรับข้อความ_ทั้งหมด_ที่สร้างโดยเครื่องมือภาพรวม (table_overview, db_overview) เมื่อดึงข้อมูลเพื่อเติมแคช สิ่งนี้ช่วยป้องกันการใช้หน่วยความจำมากเกินไปสำหรับ schema ขนาดใหญ่มากหรือตารางจำนวนมาก ค่าเริ่มต้นคือ 20000

  • STARROCKS_MCP_OUTPUT_DIR: (ไม่บังคับ) ไดเรกทอรีที่ใช้โดย read_query เมื่ออาร์กิวเมนต์ output_file เป็นเส้นทางสัมพัทธ์ ค่าเริ่มต้นคือ ~/.mcp-server-starrocks/output/ ไดเรกทอรีจะถูกสร้างขึ้นตามต้องการ เส้นทางสัมบูรณ์ที่ส่งไปยัง output_file (รวมถึงเส้นทางที่ขึ้นต้นด้วย ~) จะข้ามการตั้งค่านี้ หมายเหตุ: ไฟล์จะถูกเขียนบนเครื่องที่เซิร์ฟเวอร์ MCP ทำงาน สำหรับ Claude Code / Claude Desktop เซิร์ฟเวอร์จะทำงานในเครื่อง ดังนั้นไฟล์จะอยู่บนแล็ปท็อปของคุณ สำหรับการปรับใช้ระยะไกล/http ไฟล์จะอยู่บนเซิร์ฟเวอร์ ไม่ใช่ไคลเอ็นต์

  • STARROCKS_MYSQL_AUTH_PLUGIN: (ไม่บังคับ) ระบุปลั๊กอินการตรวจสอบสิทธิ์ที่จะใช้เมื่อเชื่อมต่อกับบริการ StarRocks FE ตัวอย่างเช่น ตั้งค่าเป็น mysql_clear_password หากการปรับใช้ StarRocks ของคุณต้องการการตรวจสอบสิทธิ์รหัสผ่านแบบข้อความชัดเจน (เช่น เมื่อใช้ LDAP หรือการตั้งค่าการตรวจสอบสิทธิ์ภายนอกบางอย่าง) ตั้งค่านี้เฉพาะเมื่อสภาพแวดล้อมของคุณต้องการโดยเฉพาะ มิฉะนั้น จะใช้ auth_plugin เริ่มต้น

  • MCP_TRANSPORT_MODE: (ไม่บังคับ) โหมดการสื่อสารที่ระบุวิธีที่เซิร์ฟเวอร์ MCP เปิดเผยบริการ ตัวเลือกที่มี:

    • stdio (ค่าเริ่มต้น): สื่อสารผ่านอินพุต/เอาต์พุตมาตรฐาน เหมาะสำหรับการโฮสต์ MCP Host
    • streamable-http (Streamable HTTP): เริ่มต้นเป็นเซิร์ฟเวอร์ Streamable HTTP รองรับการเรียก API แบบ RESTful
    • sse: (เลิกใช้แล้ว ไม่แนะนำ) เริ่มต้นในโหมดสตรีมมิ่ง Server-Sent Events (SSE) เหมาะสำหรับสถานการณ์ที่ต้องการการตอบสนองแบบสตรีมมิ่ง หมายเหตุ: โหมด SSE ไม่ได้รับการดูแลอีกต่อไป ขอแนะนำให้ใช้โหมด Streamable HTTP อย่างสม่ำเสมอ

ส่วนประกอบ

เครื่องมือ

  • read_query

    • คำอธิบาย: ดำเนินการคิวรี SELECT หรือคำสั่งอื่นๆ ที่ส่งคืน ResultSet (เช่น SHOW, DESCRIBE) สามารถเขียนผลลัพธ์ทั้งหมดไปยังไฟล์ในเครื่องแทนที่จะส่งคืนแบบอินไลน์ — มีประโยชน์สำหรับผลลัพธ์ที่ใหญ่เกินกว่าจะพอดีกับบริบทของโมเดล
    • อินพุต: 
      {
  "query": "SQL query string",
  "db": "database name (optional, uses default database if not specified)",
  "output_file": "optional path; if set, writes the full result to disk and returns only a summary + small preview. Relative paths resolve against STARROCKS_MCP_OUTPUT_DIR (default: ~/.mcp-server-starrocks/output/); absolute paths and ~ are used as-is",
  "output_format": "optional: csv | tsv | json | jsonl. If omitted, inferred from output_file extension (.csv/.tsv/.json/.jsonl/.ndjson); defaults to csv"
}
    • เอาต์พุต: หากไม่มี output_file เนื้อหาข้อความที่มีผลลัพธ์คิวรีในรูปแบบคล้าย CSV พร้อมแถวหัวข้อและสรุปจำนวนแถว หากมี output_file สรุปสั้นๆ รวมถึงเส้นทางสัมบูรณ์ที่แก้ไขแล้ว จำนวนไบต์ และจำนวนแถว พร้อมตัวอย่างเล็กน้อย ส่งคืนข้อความแสดงข้อผิดพลาดเมื่อล้มเหลว

  • write_query

    • คำอธิบาย: ดำเนินการคำสั่ง DDL (CREATE, ALTER, DROP), DML (INSERT, UPDATE, DELETE) หรือคำสั่ง StarRocks อื่นๆ ที่ไม่ส่งคืน ResultSet
    • อินพุต: 
      {
  "query": "SQL command string",
  "db": "database name (optional, uses default database if not specified)"
}
    • เอาต์พุต: เนื้อหาข้อความยืนยันความสำเร็จ (เช่น "Query OK, X rows affected") หรือรายงานข้อผิดพลาด การเปลี่ยนแปลงจะถูกคอมมิตโดยอัตโนมัติเมื่อสำเร็จ

  • analyze_query

    • คำอธิบาย: วิเคราะห์คิวรีและรับผลการวิเคราะห์โดยใช้ query profile หรือ explain analyze
    • อินพุต: 
      {
  "uuid": "Query ID, a string composed of 32 hexadecimal digits formatted as 8-4-4-4-12",
  "sql": "Query SQL to analyze",
  "db": "database name (optional, uses default database if not specified)"
}
    • เอาต์พุต: เนื้อหาข้อความที่มีผลการวิเคราะห์คิวรี ใช้ ANALYZE PROFILE FROM หากระบุ uuid มิฉะนั้นจะใช้ EXPLAIN ANALYZE หากระบุ sql

  • query_and_plotly_chart

    • คำอธิบาย: ดำเนินการคิวรี SQL โหลดผลลัพธ์ลงใน Pandas DataFrame และสร้างแผนภูมิ Plotly โดยใช้นิพจน์ Python ที่ให้มา ออกแบบมาสำหรับการแสดงภาพใน UI ที่รองรับ
    • อินพุต: 
      {
  "query": "SQL query to fetch data",
  "plotly_expr": "Python expression string using 'px' (Plotly Express) and 'df' (DataFrame). Example: 'px.scatter(df, x=\"col1\", y=\"col2\")'",
  "db": "database name (optional, uses default database if not specified)"
}
    • เอาต์พุต: รายการที่ประกอบด้วย:
      1. TextContent: การแสดงข้อความของ DataFrame และหมายเหตุว่าแผนภูมิมีไว้สำหรับแสดงผล UI
      2. ImageContent: แผนภูมิ Plotly ที่สร้างขึ้นซึ่งเข้ารหัสเป็นรูปภาพ PNG base64 (image/png) ส่งคืนข้อความแสดงข้อผิดพลาดเมื่อล้มเหลวหรือหากคิวรีไม่มีข้อมูล

  • table_overview

    • คำอธิบาย: รับภาพรวมของตารางเฉพาะ: คอลัมน์ (จาก DESCRIBE), จำนวนแถวทั้งหมด และแถวตัวอย่าง (LIMIT 3) ใช้แคชในหน่วยความจำเว้นแต่ refresh เป็นจริง
    • อินพุต: 
      {
  "table": "Table name, optionally prefixed with database name (e.g., 'db_name.table_name' or 'table_name'). If database is omitted, uses STARROCKS_DB environment variable if set.",
  "refresh": false // Optional, boolean. Set to true to bypass the cache. Defaults to false.
}
    • เอาต์พุต: เนื้อหาข้อความที่มีภาพรวมที่จัดรูปแบบแล้ว (คอลัมน์, จำนวนแถว, ข้อมูลตัวอย่าง) หรือข้อความแสดงข้อผิดพลาด ผลลัพธ์ที่แคชรวมถึงข้อผิดพลาดก่อนหน้าหากมี

  • db_overview

    • คำอธิบาย: รับภาพรวม (คอลัมน์, จำนวนแถว, แถวตัวอย่าง) สำหรับตาราง_ทั้งหมด_ภายในฐานข้อมูลที่ระบุ ใช้แคชระดับตารางสำหรับแต่ละตารางเว้นแต่ refresh เป็นจริง
    • อินพุต: 
      {
  "db": "database_name", // Optional if default database is set.
  "refresh": false // Optional, boolean. Set to true to bypass the cache for all tables in the DB. Defaults to false.
}
    • เอาต์พุต: เนื้อหาข้อความที่มีภาพรวมที่ต่อกันสำหรับตารางทั้งหมดที่พบในฐานข้อมูล คั่นด้วยส่วนหัว ส่งคืนข้อความแสดงข้อผิดพลาดหากไม่สามารถเข้าถึงฐานข้อมูลหรือไม่มีตาราง

ทรัพยากร

ทรัพยากรโดยตรง

  • starrocks:///databases
    • คำอธิบาย: แสดงรายการฐานข้อมูลทั้งหมดที่ผู้ใช้ที่กำหนดค่าไว้สามารถเข้าถึงได้
    • คิวรีที่เทียบเท่า: SHOW DATABASES
    • ประเภท MIME: text/plain

เทมเพลตทรัพยากร

  • starrocks:///{db}/{table}/schema

  • คำอธิบาย: รับนิยามสคีมาของตารางที่ระบุ

    • คิวรีที่เทียบเท่า: SHOW CREATE TABLE {db}.{table}
    • ประเภท MIME: text/plain

  • starrocks:///{db}/tables

    • คำอธิบาย: แสดงรายการตารางทั้งหมดภายในฐานข้อมูลที่ระบุ
    • คิวรีที่เทียบเท่า: SHOW TABLES FROM {db}
    • ประเภท MIME: text/plain

  • proc:///{+path}

    • คำอธิบาย: เข้าถึงข้อมูลระบบภายในของ StarRocks คล้ายกับ /proc ของ Linux พารามิเตอร์ path ระบุโหนดข้อมูลที่ต้องการ
    • คิวรีที่เทียบเท่า: SHOW PROC '/{path}'
    • ประเภท MIME: text/plain
    • พาธทั่วไป:
      • /frontends - ข้อมูลเกี่ยวกับโหนด FE
      • /backends - ข้อมูลเกี่ยวกับโหนด BE (สำหรับการปรับใช้ที่ไม่ใช่คลาวด์เนทีฟ)
      • /compute_nodes - ข้อมูลเกี่ยวกับโหนด CN (สำหรับการปรับใช้แบบคลาวด์เนทีฟ)
      • /dbs - ข้อมูลเกี่ยวกับฐานข้อมูล
      • /dbs/<DB_ID> - ข้อมูลเกี่ยวกับฐานข้อมูลที่ระบุตาม ID
      • /dbs/<DB_ID>/<TABLE_ID> - ข้อมูลเกี่ยวกับตารางที่ระบุตาม ID
      • /dbs/<DB_ID>/<TABLE_ID>/partitions - ข้อมูลพาร์ติชันสำหรับตาราง
      • /transactions - ข้อมูลธุรกรรมที่จัดกลุ่มตามฐานข้อมูล
      • /transactions/<DB_ID> - ข้อมูลธุรกรรมสำหรับ ID ฐานข้อมูลที่ระบุ
      • /transactions/<DB_ID>/running - ธุรกรรมที่กำลังทำงานสำหรับ ID ฐานข้อมูล
      • /transactions/<DB_ID>/finished - ธุรกรรมที่เสร็จสิ้นแล้วสำหรับ ID ฐานข้อมูล
      • /jobs - ข้อมูลเกี่ยวกับงานอะซิงโครนัส (Schema Change, Rollup ฯลฯ)
      • /statistic - สถิติสำหรับแต่ละฐานข้อมูล
      • /tasks - ข้อมูลเกี่ยวกับงานของเอเจนต์
      • /cluster_balance - ข้อมูลสถานะการโหลดบาลานซ์
      • /routine_loads - ข้อมูลเกี่ยวกับงาน Routine Load
      • /colocation_group - ข้อมูลเกี่ยวกับกลุ่ม Colocation Join
      • /catalog - ข้อมูลเกี่ยวกับแค็ตตาล็อกที่กำหนดค่าไว้ (เช่น Hive, Iceberg)

พรอมต์

ไม่มีการกำหนดโดยเซิร์ฟเวอร์นี้

พฤติกรรมการแคช

  • เครื่องมือ table_overview และ db_overview ใช้แคชในหน่วยความจำเพื่อจัดเก็บข้อความภาพรวมที่สร้างขึ้น
  • คีย์แคชคือทูเพิลของ (database_name, table_name)
  • เมื่อเรียก table_overview จะตรวจสอบแคชก่อน หากมีผลลัพธ์อยู่และพารามิเตอร์ refresh เป็น false (ค่าเริ่มต้น) ผลลัพธ์ที่แคชไว้จะถูกส่งคืนทันที มิฉะนั้น จะดึงข้อมูลจาก StarRocks จัดเก็บในแคช แล้วจึงส่งคืน
  • เมื่อเรียก db_overview จะแสดงรายการตารางทั้งหมดในฐานข้อมูล จากนั้นพยายามดึงภาพรวมสำหรับ แต่ละตาราง โดยใช้ตรรกะการแคชเดียวกับ table_overview (ตรวจสอบแคชก่อน ดึงข้อมูลหากจำเป็นและ refresh เป็น false หรือแคชพลาด) หาก refresh เป็น true สำหรับ db_overview จะบังคับให้รีเฟรชสำหรับ ทุก ตารางในฐานข้อมูลนั้น
  • ตัวแปรสภาพแวดล้อม STARROCKS_OVERVIEW_LIMIT ให้ เป้าหมายแบบนุ่มนวล สำหรับความยาวสูงสุดของสตริงภาพรวมที่สร้างขึ้น ต่อตาราง เมื่อเติมข้อมูลในแคช ช่วยจัดการการใช้หน่วยความจำ
  • ผลลัพธ์ที่แคชไว้ รวมถึงข้อความแสดงข้อผิดพลาดใดๆ ที่พบระหว่างการดึงข้อมูลครั้งแรก จะถูกจัดเก็บและส่งคืนเมื่อแคชถูกใช้งานในครั้งต่อๆ ไป

การดีบัก

หลังจากเริ่มต้นเซิร์ฟเวอร์ mcp คุณสามารถใช้อินสเปกเตอร์เพื่อดีบัก:

npx @modelcontextprotocol/inspector

การสาธิต

MCP Demo Image