StarRocks MCP Server
by Dorothy4285
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| STARROCKS_DB | No | (Optional) Default database to use if not specified in tool arguments or resource URIs. If set, the connection will attempt to `USE` this database. Tools like `table_overview` and `db_overview` will use this if the database part is omitted in their arguments. Defaults to empty (no default database). | |
| STARROCKS_URL | No | (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 this variable is set, it takes precedence over the individual `STARROCKS_HOST`, `STARROCKS_PORT`, `STARROCKS_USER`, `STARROCKS_PASSWORD`, and `STARROCKS_DB` variables. | |
| STARROCKS_HOST | No | (Optional) Hostname or IP address of the StarRocks FE service. Defaults to `localhost`. | localhost |
| STARROCKS_PORT | No | (Optional) MySQL protocol port of the StarRocks FE service. Defaults to `9030`. | 9030 |
| STARROCKS_USER | No | (Optional) StarRocks username. Defaults to `root`. | root |
| STARROCKS_SSL_CA | No | (Optional) Path to the CA certificate (PEM) used to verify the StarRocks server certificate. | |
| STARROCKS_SSL_KEY | No | (Optional) Path to the client private key (PEM) for mutual TLS (mTLS). | |
| MCP_TRANSPORT_MODE | No | (Optional) Communication mode that specifies how the MCP Server exposes its services. Available options: `stdio` (default), `streamable-http`, `sse` (deprecated). | stdio |
| STARROCKS_PASSWORD | No | (Optional) StarRocks password. Defaults to empty string. | |
| STARROCKS_SSL_CERT | No | (Optional) Path to the client certificate (PEM) for mutual TLS (mTLS). | |
| STARROCKS_SSL_DISABLED | No | (Optional) Set to `true` to force-disable TLS. Overrides all other SSL settings. Defaults to `false`. | false |
| STARROCKS_TLS_VERSIONS | No | (Optional) Comma-separated list of allowed TLS versions, e.g. `TLSv1.2,TLSv1.3`. | |
| STARROCKS_PASSWORD_FILE | No | (Optional) Path to a UTF-8 text file containing the password. This is useful with file-based secret injection such as systemd credentials. One trailing newline is ignored. This is only used when no explicit password is provided via `STARROCKS_PASSWORD` or `STARROCKS_URL`. | |
| STARROCKS_QUERY_TIMEOUT | No | (Optional) Number of seconds to wait for a query's results before giving up, as an integer. Unset by default, which waits indefinitely, matching prior behavior. Set this if a stuck or long-running query should fail instead of blocking a tool call forever. | |
| STARROCKS_MCP_OUTPUT_DIR | No | (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` (including `~`-prefixed paths) bypass this setting. **Note:** files are written on the machine where the MCP server runs. For Claude Code / Claude Desktop the server runs locally, so files land on your laptop. For remote/http deployments the file lands on the server, not the client. | ~/.mcp-server-starrocks/output/ |
| STARROCKS_OVERVIEW_LIMIT | No | (Optional) An _approximate_ character limit for the _total_ text generated by overview tools (`table_overview`, `db_overview`) when fetching data to populate the cache. This helps prevent excessive memory usage for very large schemas or numerous tables. Defaults to `20000`. | 20000 |
| STARROCKS_SSL_VERIFY_CERT | No | (Optional) Set to `true` to verify the server certificate against the CA. Defaults to `false`. | false |
| STARROCKS_CHART_OUTPUT_DIR | No | (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. **Note:** like other output files, charts are written on the machine where the MCP server runs. | |
| STARROCKS_MYSQL_AUTH_PLUGIN | No | (Optional) Specifies the authentication plugin to use when connecting to the StarRocks FE service. For example, set to `mysql_clear_password` if your StarRocks deployment requires clear text password authentication (such as when using certain LDAP or external authentication setups). Only set this if your environment specifically requires it; otherwise, the default auth_plugin is used. | |
| STARROCKS_SSL_VERIFY_IDENTITY | No | (Optional) Set to `true` to also verify that the server hostname matches the certificate. Defaults to `false`. | false |
| STARROCKS_CHART_DEFAULT_FORMAT | No | (Optional) Default output format for `query_and_plotly_chart` when the `format` argument is omitted. One of `json`, `png`, `jpeg` (default), or `html`. Set to `html` to always write an interactive chart file to `STARROCKS_CHART_OUTPUT_DIR` (with an inline PNG preview) without passing `format` on every call. Invalid values fall back to `jpeg` with a warning. | jpeg |
| STARROCKS_CHART_INCLUDE_PLOTLYJS | No | (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 (passed through to Plotly's `write_html`). | cdn |
| STARROCKS_FE_ARROW_FLIGHT_SQL_PORT | No | (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. The host, user, and password are taken from the same connection settings described above. | |
| STARROCKS_PASSWORD_KEYCHAIN_ACCOUNT | No | (Optional, macOS only) Generic password account name to use when reading the password from Keychain. Defaults to the resolved StarRocks user. | |
| STARROCKS_PASSWORD_KEYCHAIN_SERVICE | No | (Optional, macOS only) Generic password service name to use when reading the password from Keychain. This is only used when no explicit password or `STARROCKS_PASSWORD_FILE` is configured. | |
| STARROCKS_FE_ARROW_FLIGHT_SQL_USE_TLS | No | (Optional) Set to `true` to use `grpc+tls://` instead of plaintext `grpc://`. 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
| Name | Description |
|---|---|
No tools | |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
This server cannot be deployed
Maintenance
ActivityActive
ResponsivenessNo issues