PromptQL MCP Server

by hasura

18 193 downloads Not rated yet MIT
GitHub

About

Model Context Protocol (MCP) server for Hasura PromptQL

Details

License
MIT

Explore

- πŸ” Natural Language Data Queries - Ask questions about your enterprise data in plain English
- πŸ“Š Table Artifact Support - Get formatted table results from your data queries
- πŸ” Secure Configuration - Safely store and manage your PromptQL API credentials
- πŸ”‘ Dual Authentication Modes - Support for both public and private DDN deployments
- πŸ“ˆ Data Analysis - Get insights and visualizations from your data
- πŸ› οΈ Simple Integration - Works with Claude Desktop and other MCP-compatible clients

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name PromptQL MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Prerequisites

- Python 3.10 or higher
- A Hasura PromptQL project with API key, playground URL, and DDN Auth Token
- Claude Desktop (for interactive use) or any MCP-compatible client

Install from Source

1. Clone the repository:

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

2. Set up a virtual environment (recommended):
```bash

The server exposes the following MCP tools:

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "promptql mcp server": {
            "promptql-mcp": {
                "command": "python",
                "args": [
                    "-m",
                    "venv",
                    "venv"
                ]
            }
        }
    }
}

McpServers

{
    "promptql-mcp": {
        "command": "python",
        "args": [
            "-m",
            "venv",
            "venv"
        ]
    }
}

Status: Unstable and only for PromptQL v1. Alpha release coming soon for PromptQL v2.

Overview

This project provides a bridge between Hasura's PromptQL data agent and AI assistants through the Model Context Protocol. With this integration, AI assistants can directly query your enterprise data using natural language, leveraging PromptQL's powerful capabilities for data access, analysis, and visualization.

Features

- πŸ” Natural Language Data Queries - Ask questions about your enterprise data in plain English
- πŸ“Š Table Artifact Support - Get formatted table results from your data queries
- πŸ” Secure Configuration - Safely store and manage your PromptQL API credentials
- πŸ”‘ Dual Authentication Modes - Support for both public and private DDN deployments
- πŸ“ˆ Data Analysis - Get insights and visualizations from your data
- πŸ› οΈ Simple Integration - Works with Claude Desktop and other MCP-compatible clients

Authentication Modes

The PromptQL MCP server supports two authentication modes to work with different DDN deployment types:

Public Mode (Default)

- Uses Auth-Token header for authentication - Compatible with public DDN endpoints - Backward compatible with existing configurations - Use when: Your DDN deployment is publicly accessible

Private Mode

- Uses x-hasura-ddn-token header for authentication - Compatible with private DDN endpoints - Enhanced security for private deployments - Use when: Your DDN deployment is private/internal

You can specify the authentication mode during configuration using the --auth-mode flag or auth_mode parameter.

Installation

Prerequisites

- Python 3.10 or higher
- A Hasura PromptQL project with API key, playground URL, and DDN Auth Token
- Claude Desktop (for interactive use) or any MCP-compatible client

Install from Source

1. Clone the repository:

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

2. Set up a virtual environment (recommended):
```bash

No reviews yet β€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.