Skip to main content
Glama
Gaiad58919

StarRocks MCP Server

by Gaiad58919

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
STARROCKS_DBNo(Optional) Default database to use if not specified in tool arguments or resource URIs. Defaults to empty (no default database).
STARROCKS_URLNo(Optional) A connection URL string that contains all connection parameters in a single variable. Format: `[<schema>://]user:password@host:port/database`. The schema part is optional. When set, it takes precedence over the individual STARROCKS_HOST, STARROCKS_PORT, STARROCKS_USER, STARROCKS_PASSWORD, and STARROCKS_DB variables. Examples: `root:mypass@localhost:9030/test_db`, `mysql://admin:secret@db.example.com:9030/production`.
STARROCKS_HOSTNo(Optional) Hostname or IP address of the StarRocks FE service. Defaults to `localhost`.localhost
STARROCKS_PORTNo(Optional) MySQL protocol port of the StarRocks FE service. Defaults to `9030`.9030
STARROCKS_USERNo(Optional) StarRocks username. Defaults to `root`.root
STARROCKS_SSL_CANo(Optional) Path to the CA certificate (PEM) used to verify the StarRocks server certificate.
STARROCKS_SSL_KEYNo(Optional) Path to the client private key (PEM) for mutual TLS (mTLS).
MCP_TRANSPORT_MODENo(Optional) Communication mode that specifies how the MCP Server exposes its services. Available options: `stdio` (default), `streamable-http`, and `sse` (deprecated, not recommended).stdio
STARROCKS_PASSWORDNo(Optional) StarRocks password. Defaults to empty string.
STARROCKS_SSL_CERTNo(Optional) Path to the client certificate (PEM) for mutual TLS (mTLS).
STARROCKS_SSL_DISABLEDNo(Optional) Set to `true` to force-disable TLS. Overrides all other SSL settings. Defaults to `false`.false
STARROCKS_TLS_VERSIONSNo(Optional) Comma-separated list of allowed TLS versions, e.g. `TLSv1.2,TLSv1.3`.
STARROCKS_PASSWORD_FILENo(Optional) Path to a UTF-8 text file containing the password. Useful with file-based secret injection such as systemd credentials. One trailing newline is ignored. Only used when no explicit password is provided via STARROCKS_PASSWORD or STARROCKS_URL.
STARROCKS_QUERY_TIMEOUTNo(Optional) Number of seconds to wait for a query's results before giving up, as an integer. Unset by default, which waits indefinitely.
STARROCKS_MCP_OUTPUT_DIRNo(Optional) Directory used by `read_query` when its `output_file` argument is a relative path. Defaults to `~/.mcp-server-starrocks/output/`. The directory is created on demand. Absolute paths passed to `output_file` bypass this setting.~/.mcp-server-starrocks/output/
STARROCKS_OVERVIEW_LIMITNo(Optional) An approximate character limit for the total text generated by overview tools (`table_overview`, `db_overview`) when fetching data to populate the cache. Defaults to `20000`.20000
STARROCKS_SSL_VERIFY_CERTNo(Optional) Set to `true` to verify the server certificate against the CA. Defaults to `false`.false
STARROCKS_CHART_OUTPUT_DIRNo(Optional) Directory where `query_and_plotly_chart` writes interactive HTML charts (when `format="html"`). Defaults to the system temp directory. The directory is created on demand.
STARROCKS_MYSQL_AUTH_PLUGINNo(Optional) Specifies the authentication plugin to use when connecting to the StarRocks FE service. For example, set to `mysql_clear_password` if your deployment requires clear text password authentication.
STARROCKS_SSL_VERIFY_IDENTITYNo(Optional) Set to `true` to also verify that the server hostname matches the certificate. Defaults to `false`.false
STARROCKS_CHART_DEFAULT_FORMATNo(Optional) Default output format for `query_and_plotly_chart` when the `format` argument is omitted. One of `json`, `png`, `jpeg` (default), or `html`. Invalid values fall back to `jpeg` with a warning.
STARROCKS_CHART_INCLUDE_PLOTLYJSNo(Optional) Controls how `plotly.js` is bundled into HTML charts. `cdn` (default) keeps files small but needs network access when viewing; `inline`/`true` embeds the full library for offline use; `directory` and `false` are also accepted.
STARROCKS_FE_ARROW_FLIGHT_SQL_PORTNo(Optional) Arrow Flight SQL port of the StarRocks FE service. When set, the server connects using the high-performance Arrow Flight SQL protocol (via ADBC drivers) instead of the standard MySQL protocol. Leave unset to use the default MySQL connection.
STARROCKS_PASSWORD_KEYCHAIN_ACCOUNTNo(Optional, macOS only) Generic password account name to use when reading the password from Keychain. Defaults to the resolved StarRocks user.
STARROCKS_PASSWORD_KEYCHAIN_SERVICENo(Optional, macOS only) Generic password service name to use when reading the password from Keychain. Only used when no explicit password or STARROCKS_PASSWORD_FILE is configured.
STARROCKS_FE_ARROW_FLIGHT_SQL_USE_TLSNo(Optional) Set to `true` to use `grpc+tls://` instead of plaintext `grpc://` for the Arrow Flight SQL connection. When enabled, STARROCKS_SSL_CA is used as the TLS root certificate and STARROCKS_SSL_VERIFY_CERT=false (default) skips server certificate verification.

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Capabilities

Server capabilities have not been inspected yet.

Tools

Functions exposed to the LLM to take actions

NameDescription

No tools

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources