Promptql MCP

🚀 PromptQL MCP 服務器

本項目將 Hasura PromptQL 與像 Claude 這樣的 AI 助手相連接，藉助 Model Context Protocol（MCP）實現集成。通過該集成，AI 助手能夠運用自然語言查詢企業數據，利用 PromptQL 的強大功能實現數據的訪問、分析和可視化。

🚀 快速開始

1. 配置 PromptQL 憑證：

python -m promptql_mcp_server setup --api-key YOUR_PROMPTQL_API_KEY --ddn-url YOUR_DDN_URL

2. 測試服務器：

python -m promptql_mcp_server

3. 與服務器交互：使用示例客戶端（位於 examples 文件夾中）與服務器交互。

✨ 主要特性

• 🔍 自然語言數據查詢 - 可以使用純英文對企業數據進行提問。
• 📊 表格支持 - 能夠獲取格式化後的表格結果。
• 🔐 安全配置 - 可安全地存儲和管理 PromptQL API 憑據。
• 📈 數據分析 - 能獲得數據洞察和可視化效果。
• 🛠️ 簡單集成 - 可與 Claude Desktop 和其他 MCP 兼容客戶端一同使用。

📦 安裝指南

先決條件

• Python 3.10 或更高版本
• 帶有 API 密鑰和 DDN URL 的 Hasura PromptQL 項目
• Claude Desktop（用於交互式操作）或其他 MCP 兼容客戶端

從源碼安裝

1. 克隆倉庫：

git clone https://github.com/hasura/promptql-mcp.git
cd promptql-mcp

2. 設置虛擬環境（推薦）：

# 創建一個虛擬環境
python -m venv venv

# 激活虛擬環境
source venv/bin/activate  # 在 Windows 上：venv\Scripts\activate

3. 安裝包：

pip install -e .

💻 使用示例

基礎用法

# 服務器端代碼示例
from promptql_mcp_server.server import MCPServer

server = MCPServer()
server.run()

高級用法

# 客戶端端代碼示例
import requests

response = requests.post('http://localhost:5000/query', json={
    "model": "claude-2",
    "messages": [
        {
            "role": "user",
            "content": "告訴我今天的天氣如何？"
        }
    ]
})
print(response.json())

📚 詳細文檔

完整的 API 文檔和更多詳細信息請參考項目倉庫中的 DOCS.md。

📄 許可證

本項目在 MIT License 下許可，詳情請查看 LICENSE 文件。

致謝

• Hasura 創建 PromptQL
• Anthropic 開發 Model Context Protocol