GreptimeDB MCP Server

ทางการ

มอบวิธีการที่ปลอดภัยและมีโครงสร้างให้กับผู้ช่วย AI ในการสำรวจและวิเคราะห์ข้อมูลใน GreptimeDB

เอกสาร

greptimedb-mcp-server

เซิร์ฟเวอร์ Model Context Protocol (MCP) สำหรับ GreptimeDB — ฐานข้อมูลเชิงสังเกตการณ์แบบโอเพนซอร์สที่จัดการเมตริก ล็อก และเทรซในเอนจินเดียว

ช่วยให้ผู้ช่วย AI สามารถสืบค้นและวิเคราะห์ GreptimeDB โดยใช้ SQL, TQL (เข้ากันได้กับ PromQL) และคำสั่ง RANGE พร้อมคุณสมบัติความปลอดภัยในตัว เช่น การบังคับใช้แบบอ่านอย่างเดียวและการปิดบังข้อมูล

เริ่มต้นอย่างรวดเร็ว

# Install
pip install greptimedb-mcp-server

# Run (connects to localhost:4002 by default)
greptimedb-mcp-server --host localhost --database public

สำหรับ Claude Desktop ให้เพิ่มสิ่งนี้ลงในการกำหนดค่าของคุณ (~/Library/Application Support/Claude/claude_desktop_config.json บน macOS):

{
  "mcpServers": {
    "greptimedb": {
      "command": "greptimedb-mcp-server",
      "args": ["--host", "localhost", "--database", "public"]
    }
  }
}

คุณสมบัติ

เครื่องมือ

เครื่องมือ	คำอธิบาย
`execute_sql`	ดำเนินการสืบค้น SQL ด้วยตัวเลือกรูปแบบ (csv/json/markdown) และการจำกัดจำนวน
`execute_tql`	ดำเนินการสืบค้น TQL (เข้ากันได้กับ PromQL) สำหรับการวิเคราะห์อนุกรมเวลา
`query_range`	ดำเนินการสืบค้นการรวมช่วงเวลาด้วยไวยากรณ์ RANGE/ALIGN
`describe_table`	ตรวจสอบโปรไฟล์ตาราง: สคีมา, ข้อมูลเมตาเชิงความหมาย, แถวตัวอย่างล่าสุด และคำแนะนำการสืบค้น
`explain_query`	วิเคราะห์แผนการดำเนินการสืบค้น SQL หรือ TQL (`analyze=true` สำหรับสถิติรันไทม์; เพิ่ม `verbose=true` ควบคู่กับ `analyze=true` สำหรับเมตริกการสแกนต่อพาร์ติชันและตัวนับการตัดแต่งดัชนี)
`health_check`	ตรวจสอบสถานะการเชื่อมต่อฐานข้อมูลและเวอร์ชันเซิร์ฟเวอร์

การจัดการไปป์ไลน์

เครื่องมือ	คำอธิบาย
`list_pipelines`	แสดงรายการไปป์ไลน์ทั้งหมดหรือดูรายละเอียดของไปป์ไลน์เฉพาะ
`create_pipeline`	สร้างไปป์ไลน์ใหม่ด้วยการกำหนดค่า YAML
`dryrun_pipeline`	ทดสอบไปป์ไลน์ด้วยข้อมูลตัวอย่างโดยไม่เขียนลงฐานข้อมูล
`delete_pipeline`	ลบเวอร์ชันเฉพาะของไปป์ไลน์

การจัดการแดชบอร์ด

เครื่องมือ	คำอธิบาย
`list_dashboards`	แสดงรายการคำจำกัดความแดชบอร์ด Perses ทั้งหมด
`create_dashboard`	สร้างหรืออัปเดตคำจำกัดความแดชบอร์ด Perses
`delete_dashboard`	ลบคำจำกัดความแดชบอร์ด

ทรัพยากรและพรอมต์

ทรัพยากร: เรียกดูตารางผ่าน URI greptime://<table>/data
พรอมต์: เทมเพลต Jinja ในตัวสำหรับงานทั่วไป — pipeline_creator, log_pipeline, metrics_analysis, promql_analysis, trace_analysis, table_operation, schema_design_advisor, observability_correlation, ingestion_troubleshooting, query_performance_tuning

สำหรับการรวม LLM และการใช้งานพรอมต์ ดู docs/llm-instructions.md

การกำหนดค่า

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

GREPTIMEDB_HOST=localhost      # Database host
GREPTIMEDB_PORT=4002           # MySQL protocol port (default: 4002)
GREPTIMEDB_USER=root           # Database user
GREPTIMEDB_PASSWORD=           # Database password
GREPTIMEDB_DATABASE=public     # Database name
GREPTIMEDB_TIMEZONE=UTC        # Session timezone

# Optional
GREPTIMEDB_HTTP_PORT=4000      # HTTP API port for pipeline/dashboard management
GREPTIMEDB_HTTP_PROTOCOL=http  # HTTP protocol (http/https)
GREPTIMEDB_POOL_SIZE=5         # Connection pool size
GREPTIMEDB_MASK_ENABLED=true   # Enable sensitive data masking
GREPTIMEDB_MASK_PATTERNS=      # Additional patterns (comma-separated)
GREPTIMEDB_AUDIT_ENABLED=true  # Enable audit logging
GREPTIMEDB_ALLOW_WRITE=false   # Allow write/DDL via execute_sql (DANGEROUS, local/test only)

# Transport (for HTTP server mode)
GREPTIMEDB_TRANSPORT=stdio     # stdio, sse, or streamable-http
GREPTIMEDB_LISTEN_HOST=0.0.0.0 # HTTP server bind host
GREPTIMEDB_LISTEN_PORT=8080    # HTTP server bind port
GREPTIMEDB_ALLOWED_HOSTS=      # DNS rebinding protection (comma-separated)
GREPTIMEDB_ALLOWED_ORIGINS=    # CORS allowed origins (comma-separated)

อาร์กิวเมนต์ CLI

greptimedb-mcp-server \
  --host localhost \
  --port 4002 \
  --database public \
  --user root \
  --password "" \
  --timezone UTC \
  --pool-size 5 \
  --mask-enabled true \
  --allow-write false \
  --transport stdio

โหมดเซิร์ฟเวอร์ HTTP

สำหรับการปรับใช้แบบคอนเทนเนอร์หรือ Kubernetes ต้องใช้ mcp>=1.8.0:

# Streamable HTTP (recommended for production)
greptimedb-mcp-server --transport streamable-http --listen-port 8080

# SSE mode (legacy)
greptimedb-mcp-server --transport sse --listen-port 3000

การป้องกันการรีไบน์ดิง DNS

ตามค่าเริ่มต้น การป้องกันการรีไบน์ดิง DNS จะถูกปิดใช้งานเพื่อความเข้ากันได้กับพร็อกซี เกตเวย์ และบริการ Kubernetes หากต้องการเปิดใช้งาน ให้ใช้ --allowed-hosts:

# Enable DNS rebinding protection with allowed hosts
greptimedb-mcp-server --transport streamable-http \
  --allowed-hosts "localhost:*,127.0.0.1:*,my-service.namespace:*"

# With custom allowed origins for CORS
greptimedb-mcp-server --transport streamable-http \
  --allowed-hosts "my-service.namespace:*" \
  --allowed-origins "http://localhost:*,https://my-app.example.com"

# Or via environment variables
GREPTIMEDB_ALLOWED_HOSTS="localhost:*,my-service.namespace:*" \
GREPTIMEDB_ALLOWED_ORIGINS="http://localhost:*" \
  greptimedb-mcp-server --transport streamable-http

หากคุณพบข้อผิดพลาด 421 Invalid Host Header ให้ปิดการป้องกัน (ค่าเริ่มต้น) หรือเพิ่มโฮสต์ของคุณลงในรายการที่อนุญาต

ความปลอดภัย

ผู้ใช้ฐานข้อมูลแบบอ่านอย่างเดียว (แนะนำ)

สร้างผู้ใช้แบบอ่านอย่างเดียวใน GreptimeDB โดยใช้ ผู้ให้บริการผู้ใช้แบบคงที่:

mcp_readonly:readonly=your_secure_password

เกตความปลอดภัยระดับแอปพลิเคชัน

การสืบค้นทั้งหมดผ่านเกตความปลอดภัยที่:

บล็อก: DROP, DELETE, TRUNCATE, UPDATE, INSERT, ALTER, CREATE, GRANT, REVOKE, EXEC, LOAD, COPY
บล็อก: ความพยายามบายพาสที่เข้ารหัส (hex, UNHEX, CHAR)
อนุญาต: SELECT, SHOW, DESCRIBE, TQL, EXPLAIN, UNION

โหมดเขียน (ปิดใช้งานตามค่าเริ่มต้น)

เซิร์ฟเวอร์เป็นแบบอ่านอย่างเดียวตามค่าเริ่มต้น สำหรับการพัฒนาในเครื่องหรือการทดสอบ คุณสามารถ อนุญาต SQL เขียน/ทำลาย (DDL/DML เช่น CREATE, DROP, ALTER, INSERT, UPDATE, DELETE) ผ่านเครื่องมือ execute_sql โดยเปิดใช้งานโหมดเขียน:

# Environment variable
GREPTIMEDB_ALLOW_WRITE=true greptimedb-mcp-server

# Or CLI argument
greptimedb-mcp-server --allow-write true

เมื่อเปิดใช้งาน เกตความปลอดภัยจะถูกบายพาสสำหรับ execute_sql และเซิร์ฟเวอร์ จะบันทึกคำเตือนเมื่อเริ่มต้น

⚠️ อันตราย: สิ่งนี้ทำให้ผู้ช่วย AI สามารถรันคำสั่งทำลายล้างกับ ฐานข้อมูลของคุณได้ อย่าเปิดใช้งานกับข้อมูลการผลิต รวมกับผู้ใช้ฐานข้อมูล แบบอ่านอย่างเดียวหากคุณต้องการเพียงการเข้าถึงแบบอ่าน

การปิดบังข้อมูล

คอลัมน์ที่ละเอียดอ่อนจะถูกปิดบังโดยอัตโนมัติ (******) ตามรูปแบบชื่อคอลัมน์:

การรับรองความถูกต้อง: password, secret, token, api_key, credential
การเงิน: credit_card, cvv, bank_account
ส่วนบุคคล: ssn, id_card, passport

กำหนดค่าด้วย --mask-patterns phone,email เพื่อเพิ่มรูปแบบที่กำหนดเอง

การบันทึกการตรวจสอบ

การเรียกใช้เครื่องมือทั้งหมดจะถูกบันทึก:

2025-12-10 10:30:45 - greptimedb_mcp_server.audit - INFO - [AUDIT] execute_sql | query="SELECT * FROM cpu LIMIT 10" | success=True | duration_ms=45.2

ปิดใช้งานด้วย --audit-enabled false

การพัฒนา

# Clone and setup
git clone https://github.com/GreptimeTeam/greptimedb-mcp-server.git
cd greptimedb-mcp-server
uv venv && source .venv/bin/activate
uv sync

# Run tests
pytest

# Format & lint
uv run black .
uv run flake8 src

# Debug with MCP Inspector
npx @modelcontextprotocol/inspector uv --directory . run -m greptimedb_mcp_server.server

ใบอนุญาต

ใบอนุญาต MIT - ดู LICENSE.md

กิตติกรรมประกาศ

ได้รับแรงบันดาลใจจาก: