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§
- Analyze
Table Args - Arguments for the
analyze-tableprompt. - Attach
Database Params - Parameters for the
attach_databasetool. MirrorsAttachSpecexcept that these attachments live for the rest of the MCP session (or untildetach_databaseis called). - Attach
Spec - One database to attach for the duration of a single
copy_querycall. Same kind-tagged shape asAttachDatabaseParamsso the vocabulary stays consistent once remote kinds (tcp/grpc) arrive. - Chart
Params - Parameters for the
charttool. - Compare
Tables Args - Arguments for the
compare-tablesprompt. - Copy
Query Params - Parameters for the
copy_querytool. Runs a read-only SELECT / WITH / VALUES statement and lands the result into a target table. - Data
Quality Args - Arguments for the
data-qualityprompt. - Delete
Query Params - Parameters for the
delete_querytool. - Describe
Params - Parameters for the
describetool. Both fields are optional to preserve backward compatibility with callers that invokedescribewith no args to get the full workspace listing. - Detach
Database Params - Parameters for the
detach_databasetool. - Execute
Params - Parameters for the mutating
executeworkspace tool. - Export
Params - Parameters for the
exporttool. - Hyper
McpServer - The MCP server that registers all Hyper tools and routes invocations.
- Inspect
File Params - Parameters for the
inspect_filetool. - KvKey
Params - Parameters for the key-scoped KV tools (
kv_get,kv_delete). - KvList
Stores Params - Parameters for
kv_list_stores(enumerate every store in a database). - KvSet
Params - Parameters for
kv_set(write a value under store + key). - KvStore
Params - Parameters for store-scoped KV tools (
kv_list,kv_size,kv_pop,kv_clear). - Load
Data Params - Parameters for the
load_dataworkspace tool. - Load
File Params - Parameters for the
load_fileworkspace tool. - Load
Files Entry - One file entry within a
LoadFilesParamsbatch. Same shape asLoadFileParamsminus cross-cutting concerns handled at the batch level (the batch-level concurrency knob, etc.). - Load
Files Params - Parameters for the
load_filesworkspace tool. - Load
Iceberg Params - Parameters for the
load_icebergworkspace tool. - Query
Data Params - Schema override shape shared by
query_data,query_file,load_data, andload_file. Documented here once so all four tools can reference it without duplicating the prose in every field doc. - Query
File Params - Parameters for the
query_fileone-shot tool. - Query
Params - Parameters for the read-only
queryworkspace tool. - Sample
Params - Parameters for the
sampleconvenience tool. - Save
Query Params - Parameters for the
save_querytool. - SetTable
Metadata Params - Parameters for the
set_table_metadatatool. - Suggest
Queries Args - Arguments for the
suggest-queriesprompt. - Unwatch
Directory Params - Parameters for the
unwatch_directorytool. - Watch
Directory Params - Parameters for the
watch_directorytool.
Enums§
- Merge
Key - One or many column names. Accepts either a JSON string
"col"or a JSON array["col1", "col2"]for ergonomics — the tool layer normalizes toVec<String>before passing into the ingest code. - Resource
Body - 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.