CrateDB MCP Server

Status CI Coverage Downloads per month

License Release Notes PyPI Version Python Versions

» Documentation | Issues | Source code | License | CrateDB | CrateDB Handbook | Community Forum

About

The CrateDB MCP Server for natural-language Text-to-SQL and documentation retrieval specializes in CrateDB database clusters. The Model Context Protocol (MCP) is a protocol that standardizes providing context to language models and AI assistants.

The CrateDB Model Context Protocol (MCP) Server connects AI assistants directly to your CrateDB clusters and the CrateDB knowledge base, enabling seamless interaction through natural language.

It serves as a bridge between AI tools and your analytics database, allowing you to analyze data, the cluster state, troubleshoot issues, and perform operations using conversational prompts.

Quickstart Guide

The CrateDB MCP Server is compatible with AI assistants that support the Model Context Protocol (MCP), either using standard input/output (stdio), server-sent events (sse), or HTTP Streams (http, earlier streamable-http).

To use the MCP server, you need a client that supports the protocol. The most notable ones are ChatGPT, Claude, Cline Bot, Cursor, GitHub Copilot, Mistral AI, OpenAI Agents SDK, Windsurf, and others.

This section includes detailed information about how to configure and operate the CrateDB MCP Server.

  Install
Installation
  Configure
Configuration
  Use
Usage

What’s inside

This section includes information about the included MCP tools.

Tools are a powerful primitive in the Model Context Protocol (MCP) that enable servers to expose executable functionality to clients. Through tools, LLMs can interact with external systems, perform computations, and take actions in the real world.

The CrateDB MCP Server provides two families of tools.

Text-to-SQL:

The tools query_sql, get_table_columns, and get_table_metadata talk to a CrateDB database cluster to inquire database and table metadata, and table content.

Documentation inquiry:

The tools get_cratedb_documentation_index and fetch_cratedb_docs look up guidelines specific to CrateDB topics, to provide the most accurate information possible. Relevant information is pulled from https://cratedb.com/docs, curated per cratedb-outline.yaml through the cratedb-about package.

Health status:

The tool get_cluster_health returns cluster health information derived from CrateDB’s system tables.

Note

Experimental: Please note that the CrateDB MCP Server is an experimental feature provided as-is without warranty or support guarantees. Enterprise customers should use this feature at their own discretion.