🚀 PromptQL MCP 服务器
本项目致力于搭建一座桥梁，将 Hasura PromptQL 与如 Claude 这般的 AI 助手相连接，借助 Model Context Protocol（MCP）达成集成。通过此集成，AI 助手能够运用自然语言对企业数据进行查询，充分发挥 PromptQL 强大的数据访问、分析和可视化功能。
🚀 快速开始
- 配置 PromptQL 凭证：
python -m promptql_mcp_server setup --api-key YOUR_PROMPTQL_API_KEY --ddn-url YOUR_DDN_URL
- 测试服务器：
python -m promptql_mcp_server
- 与服务器交互：使用示例客户端（位于 examples 文件夹中）与服务器进行交互。
✨ 主要特性
- 🔍 自然语言数据查询 - 可使用 plain English 对企业数据进行提问。
- 📊 表格支持 - 能够获取格式化后的表格结果。
- 🔐 安全配置 - 可安全存储和管理 PromptQL API 凭据。
- 📈 数据分析 - 可获得数据洞察和可视化效果。
- 🛠️ 简单集成 - 能与 Claude Desktop 和其他 MCP 兼容客户端配合使用。
📦 安装指南
先决条件
- Python 3.10 或更高版本。
- 带有 API 密钥和 DDN URL 的 Hasura PromptQL 项目。
- Claude Desktop（用于交互式操作）或其他 MCP 兼容客户端。
从源码安装
- 克隆仓库：
git clone https://github.com/hasura/promptql-mcp.git
cd promptql-mcp
- 设置虚拟环境（推荐）：
# 创建一个虚拟环境
python -m venv venv
# 激活虚拟环境
source venv/bin/activate # 在 Windows 上：venv\Scripts\activate
- 安装包：
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。
🤝 贡献
欢迎贡献！请随意提交 Pull Request。
- 叉仓库。
- 创建功能分支 (
git checkout -b feature/amazing-feature)。 - 提交更改 (
git commit -m '添加一些神奇的功能')。 - 推送到分支 (
git push origin feature/amazing-feature)。 - 打开 Pull Request。
📄 许可证
本项目在 MIT License 下许可，详情请查看 LICENSE 文件。