PromptQL MCP Server
by Hasura
Connect Hasura PromptQL to AI assistants like Claude using the Model Context Protocol (MCP). This allows AI assistants to directly query your enterprise data using natural language.
Last updated: N/A
PromptQL MCP Server
Connect Hasura PromptQL to AI assistants like Claude using the Model Context Protocol (MCP).
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
- š Data Analysis - Get insights and visualizations from your data
- š ļø Simple Integration - Works with Claude Desktop and other MCP-compatible clients
Installation
Prerequisites
- Python 3.10 or higher
- A Hasura PromptQL project with API key and DDN URL
- Claude Desktop (for interactive use) or any MCP-compatible client
Install from Source
git clone https://github.com/hasura/promptql-mcp-server.git
cd promptql-mcp-server
pip install -e .
Quick Start
- Configure your PromptQL credentials:
python -m promptql_mcp_server setup --api-key YOUR_API_KEY --ddn-url YOUR_DDN_URL
- Test the server:
python -m promptql_mcp_server
- In a new terminal, try the example client:
python examples/simple_client.py
Using with Claude Desktop
- Install Claude Desktop
- Open Claude Desktop and go to Settings > Developer
- Click "Edit Config" and add the following:
{
"mcpServers": {
"promptql": {
"command": "python",
"args": ["-m", "promptql_mcp_server"]
}
}
}
- Restart Claude Desktop
- Chat with Claude and use natural language to query your data
Example Prompts for Claude
- "What were our total sales last quarter?"
- "Who are our top five customers by revenue?"
- "Show me the trend of new user signups over the past 6 months"
- "Which products have the highest profit margin?"
Available Tools and Prompts
Tools
The server exposes the following MCP tools:
- ask_question - Ask natural language questions about your data
- setup_config - Configure PromptQL API key and DDN URL
- check_config - Verify the current configuration status
Prompts
- data_analysis - Create a specialized prompt for data analysis on a specific topic
Architecture
This integration follows a client-server architecture:
- PromptQL MCP Server - A Python server that exposes PromptQL capabilities through the MCP protocol
- MCP Client - Any client that implements the MCP protocol (e.g., Claude Desktop)
- PromptQL API - Hasura's Natural Language API for data access and analysis
The server translates between the MCP protocol and PromptQL's API, allowing seamless integration between AI assistants and your enterprise data.
Development
Project Structure
promptql-mcp-server/
āāā promptql_mcp_server/ # Main package
ā āāā __init__.py
ā āāā __main__.py # Entry point
ā āāā server.py # MCP server implementation
ā āāā config.py # Configuration management
ā āāā api/ # API clients
ā āāā __init__.py
ā āāā promptql_client.py # PromptQL API client
āāā examples/ # Example clients
ā āāā simple_client.py # Simple MCP client
āāā setup.py # Package configuration
āāā README.md # Documentation
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.