PromptQL MCP 服务器

将 Hasura PromptQL 连接至像Claude这样的 AI 助手，使用 Model Context Protocol（MCP）进行集成。

概述

此项目提供了一个桥梁，连接 Hasura 的 PromptQL 数据代理与 AI 助手，通过 Model Context Protocol 实现数据交互。借助这一集成，AI 助手可以直接使用自然语言查询您的企业数据，利用 PromptQL 强大的功能实现数据访问、分析和可视化。

特性

• 🔍 自然语言数据查询 - 使用 plain English 提问关于您企业数据的问题
• 📊 表格支持 - 获取格式化后的表格结果
• 🔐 安全配置 - 安全存储和管理 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 .

快速开始

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 文件夹中）与服务器交互。

示例

服务器端代码示例

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。

贡献

欢迎贡献！请随意提交 Pull Request。

1. 叉仓库
2. 创建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m '添加一些神奇的功能')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开 Pull Request

许可证

本项目在 MIT License 下许可，详情请查看 LICENSE 文件。

致谢

• Hasura 创建 PromptQL
• Anthropic 开发 Model Context Protocol