Expand description
MCP (Model Context Protocol) server that exposes the Hyper columnar database as an instant SQL analytics engine for LLM workflows.
§Architecture
The crate is layered bottom-up:
error— Structured error codes with recovery suggestions for LLM self-correction.attach— Registry of additional.hyperdatabases attached to the primary workspace for cross-database JOINs andcopy_query. Replays attachments after aConnectionLostreconnect.stats— Performance telemetry (throughput, timing) attached to every response.schema— Three-tier schema inference: exact (Arrow/Parquet), structural (JSON), heuristic (CSV). Also handles user-provided schema overrides.engine— Manages theHyperProcesslifecycle, connection, table CRUD, and query execution. Supports ephemeral and persistent workspace modes.ingest— Loads inline JSON (row-by-row INSERT) and CSV (COPY FROM) into Hyper.ingest_arrow— Loads Parquet and Arrow IPC files via the Arrow crate.inspect— Dry-run file inspection powering theinspect_fileMCP tool.export— Writes query results to CSV, Parquet, Arrow IPC, or.hyperfiles.chart— Renders SQL query results as PNG/SVG charts via theplotterscrate.saved_queries— Named read-only SQL queries exposed via tools andhyper://queries/...resources.subscriptions— Per-URI registry of MCP clients that asked for resource-update notifications.table_catalog— User-visible catalog of data tables (_table_catalog) tracking source, purpose, and load history so workspaces are self-documenting. Disabled by--bare.version— Compile-time-captured version strings for the MCP crate and the underlyinghyperdb-api, with a git-hash suffix.readme— Static LLM-facing README returned by theget_readmetool.watcher— Monitors directories for incremental ingest via a.readysentinel protocol.server— MCP tool definitions and thermcpserver handler that ties everything together.
Modules§
- attach
- Registry of attached databases for cross-database queries.
- chart
- Chart rendering for query results.
- engine
- Core database engine that owns the
HyperProcessand its connection. - error
- Structured error types for MCP tool responses.
- export
- Export query results or whole tables to files.
- ingest
- Ingest inline data (JSON strings, CSV strings) and CSV files into Hyper tables.
- ingest_
arrow - Ingest Parquet and Arrow IPC files into Hyper tables.
- inspect
- Dry-run file inspection for the
inspect_fileMCP tool. - lakehouse
- Ingest Apache Iceberg tables into Hyper using hyperd’s native
external(..., format => 'iceberg')scan. - readme
- LLM-facing README returned by the
get_readmetool. - saved_
queries - Named read-only SQL queries exposed via the
save_query/delete_querytools and thehyper://queries/{name}/definition+hyper://queries/{name}/resultresources. - schema
- Schema inference and type mapping.
- server
- MCP server implementation and tool parameter types.
- stats
- Performance telemetry attached to every MCP tool response.
- subscriptions
- Resource-update subscription registry backing the server-side hooks
for
resources/subscribe,resources/unsubscribe, and the two MCP notifications the server emits after workspace mutations. - table_
catalog - User-visible catalog of data tables in the workspace.
- version
- Version reporting for the
HyperDBMCP server. - watcher
- Directory watcher for incremental ingest.