Skip to main content

Module server

Module server 

Source
Expand description

MCP server implementation and tool parameter types.

The HyperMcpServer is the top-level struct registered with the rmcp framework. It lazily initializes the Engine on first tool call and routes each MCP tool invocation to the appropriate ingest / query / export function.

Parameter structs derive JsonSchema so the MCP tools/list response includes full JSON Schema descriptions for each tool’s inputs.

Structs§

AnalyzeTableArgs
Arguments for the analyze-table prompt.
AttachDatabaseParams
Parameters for the attach_database tool. Mirrors AttachSpec except that these attachments live for the rest of the MCP session (or until detach_database is called).
AttachSpec
One database to attach for the duration of a single copy_query call. Same kind-tagged shape as AttachDatabaseParams so the vocabulary stays consistent once remote kinds (tcp / grpc) arrive.
ChartParams
Parameters for the chart tool.
CompareTablesArgs
Arguments for the compare-tables prompt.
CopyQueryParams
Parameters for the copy_query tool. Runs a read-only SELECT / WITH / VALUES statement and lands the result into a target table.
DataQualityArgs
Arguments for the data-quality prompt.
DeleteQueryParams
Parameters for the delete_query tool.
DescribeParams
Parameters for the describe tool. Both fields are optional to preserve backward compatibility with callers that invoke describe with no args to get the full workspace listing.
DetachDatabaseParams
Parameters for the detach_database tool.
ExecuteParams
Parameters for the mutating execute workspace tool.
ExportParams
Parameters for the export tool.
HyperMcpServer
The MCP server that registers all Hyper tools and routes invocations.
InspectFileParams
Parameters for the inspect_file tool.
LoadDataParams
Parameters for the load_data workspace tool.
LoadFileParams
Parameters for the load_file workspace tool.
LoadFilesEntry
One file entry within a LoadFilesParams batch. Same shape as LoadFileParams minus cross-cutting concerns handled at the batch level (the batch-level concurrency knob, etc.).
LoadFilesParams
Parameters for the load_files workspace tool.
LoadIcebergParams
Parameters for the load_iceberg workspace tool.
QueryDataParams
Schema override shape shared by query_data, query_file, load_data, and load_file. Documented here once so all four tools can reference it without duplicating the prose in every field doc.
QueryFileParams
Parameters for the query_file one-shot tool.
QueryParams
Parameters for the read-only query workspace tool.
SampleParams
Parameters for the sample convenience tool.
SaveQueryParams
Parameters for the save_query tool.
SetTableMetadataParams
Parameters for the set_table_metadata tool.
SuggestQueriesArgs
Arguments for the suggest-queries prompt.
UnwatchDirectoryParams
Parameters for the unwatch_directory tool.
WatchDirectoryParams
Parameters for the watch_directory tool.

Enums§

MergeKey
One or many column names. Accepts either a JSON string "col" or a JSON array ["col1", "col2"] for ergonomics — the tool layer normalizes to Vec<String> before passing into the ingest code.
ResourceBody
The payload of a resource read, carrying both MIME type and serialized content. Different resources speak different formats (JSON for metadata, markdown for human overviews, CSV for spreadsheet consumers), so the resource layer needs to pass both along to the MCP client.