StarRocks
oficialInteraja com o StarRocks
O que você pode fazer com StarRocks MCP?
- Executar consultas SQL somente leitura — execute instruções
SELECT,SHOWouDESCRIBEviaread_querye, opcionalmente, salve grandes resultados em um arquivo. - Executar comandos DDL/DML — realize operações
CREATE,INSERT,UPDATEouDELETEcomwrite_querye obtenha uma confirmação de linhas afetadas. - Explorar esquemas de banco de dados — liste bancos de dados, tabelas e recupere definições de
SHOW CREATE TABLEpor meio de recursosstarrocks://. - Obter visões gerais de tabelas e bancos de dados — use
table_overviewoudb_overviewpara buscar definições de colunas, contagens de linhas e linhas de exemplo, com cache em memória. - Visualizar resultados de consultas como gráficos — forneça uma consulta SQL e uma expressão Plotly para
query_and_plotly_charte receba uma imagem do gráfico. - Inspecionar saúde do cluster e hotspots — identifique tabelas frequentemente acessadas com
top_hot_tablesou tabelas com baixa saúde comtop_bad_tables, e acesse métricas internas do sistema via recursosproc://.
Documentação
Servidor MCP Oficial do StarRocks
O Servidor MCP do StarRocks atua como uma ponte entre assistentes de IA e bancos de dados StarRocks. Ele permite a execução direta de SQL, exploração de banco de dados, visualização de dados por meio de gráficos e recuperação de visões gerais detalhadas de esquemas/dados sem exigir configuração complexa do lado do cliente.
Funcionalidades
- Execução Direta de SQL: Execute consultas
SELECT(read_query) e comandos DDL/DML (write_query). - Exploração de Banco de Dados: Liste bancos de dados e tabelas, recupere esquemas de tabelas (recursos
starrocks://). - Informações do Sistema: Acesse métricas e estados internos do StarRocks através do caminho de recurso
proc://. - Visões Gerais Detalhadas: Obtenha resumos abrangentes de tabelas (
table_overview) ou bancos de dados inteiros (db_overview), incluindo definições de colunas, contagens de linhas e dados de amostra. - Visualização de Dados: Execute uma consulta e gere um gráfico Plotly diretamente dos resultados (
query_and_plotly_chart). - Cache Inteligente: Visões gerais de tabelas e bancos de dados são armazenadas em cache na memória para acelerar solicitações repetidas. O cache pode ser ignorado quando necessário.
- Configuração Flexível: Defina detalhes de conexão e comportamento por meio de variáveis de ambiente.
Pré-requisitos
- Python 3.11 ou mais recente.
- Um cluster StarRocks acessível (serviço FE). Por padrão, o servidor conecta-se a
localhost:9030através do protocolo MySQL. uv— um gerenciador rápido de pacotes e projetos Python (um substituto moderno parapip+virtualenv) da Astral. Este projeto usauvpara resolver dependências, criar o ambiente virtual e iniciar o servidor. Os comandosuv runao longo deste README criam automaticamente um ambiente isolado e instalam as dependências necessárias no primeiro uso, portanto, nenhuma etapa manual depip installé necessária.
Instalando o uv
# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# Or via Homebrew / pipx / pip
brew install uv
# pipx install uv
# pip install uv
Consulte o guia oficial de instalação do uv para outras opções. Após a instalação, verifique se ele está no seu PATH:
uv --version
Instalação
Geralmente, você não precisa instalar o pacote manualmente — o host MCP o inicia para você via uv (veja Configuração abaixo). O uv busca o pacote e suas dependências sob demanda.
Para executá-lo diretamente para teste ou desenvolvimento:
# Run the published package in a throwaway environment
uv run --with mcp-server-starrocks mcp-server-starrocks --help
# Or, from a local checkout of this repository
git clone https://github.com/starrocks/mcp-server-starrocks.git
cd mcp-server-starrocks
uv sync # create the virtual environment and install dependencies
uv run mcp-server-starrocks --help
Configuração
O servidor MCP é normalmente executado por meio de um host MCP. A configuração é passada para o host, especificando como iniciar o processo do servidor MCP do StarRocks.
Usando HTTP Transmissível (recomendado):
Para iniciar o servidor no modo HTTP Transmissível:
Primeiro, teste se a conexão com o StarRocks está OK (9030 é a porta do protocolo MySQL do StarRocks, não a porta do servidor HTTP):
$ STARROCKS_URL=root:@localhost:9030 uv run mcp-server-starrocks --test
Inicie o servidor:
uv run mcp-server-starrocks --mode streamable-http --port 8000
Em seguida, configure o MCP assim:
{
"mcpServers": {
"mcp-server-starrocks": {
"url": "http://localhost:8000/mcp"
}
}
}
Usando uv com pacote instalado (variáveis de ambiente individuais):
{
"mcpServers": {
"mcp-server-starrocks": {
"command": "uv",
"args": ["run", "--with", "mcp-server-starrocks", "mcp-server-starrocks"],
"env": {
"STARROCKS_HOST": "default localhost",
"STARROCKS_PORT": "default 9030",
"STARROCKS_USER": "default root",
"STARROCKS_PASSWORD": "default empty",
"STARROCKS_DB": "default empty"
}
}
}
}
Usando uv com pacote instalado (URL de conexão):
{
"mcpServers": {
"mcp-server-starrocks": {
"command": "uv",
"args": ["run", "--with", "mcp-server-starrocks", "mcp-server-starrocks"],
"env": {
"STARROCKS_URL": "root:password@localhost:9030/my_database"
}
}
}
}
Usando uv com diretório local (para desenvolvimento):
{
"mcpServers": {
"mcp-server-starrocks": {
"command": "uv",
"args": [
"--directory",
"path/to/mcp-server-starrocks", // <-- Update this path
"run",
"mcp-server-starrocks"
],
"env": {
"STARROCKS_HOST": "default localhost",
"STARROCKS_PORT": "default 9030",
"STARROCKS_USER": "default root",
"STARROCKS_PASSWORD": "default empty",
"STARROCKS_DB": "default empty"
}
}
}
}
Usando uv com diretório local e URL de conexão:
{
"mcpServers": {
"mcp-server-starrocks": {
"command": "uv",
"args": [
"--directory",
"path/to/mcp-server-starrocks", // <-- Update this path
"run",
"mcp-server-starrocks"
],
"env": {
"STARROCKS_URL": "root:password@localhost:9030/my_database"
}
}
}
}
Argumentos de Linha de Comando:
O servidor suporta os seguintes argumentos de linha de comando:
uv run mcp-server-starrocks --help
--mode {stdio,sse,http,streamable-http}: Modo de transporte (padrão: stdio ou variável de ambiente MCP_TRANSPORT_MODE)--host HOST: Host do servidor para modos HTTP (padrão: localhost)--port PORT: Porta do servidor para modos HTTP--test: Executar em modo de teste para verificar a funcionalidade
Exemplos:
# Start in streamable HTTP mode on custom host/port
uv run mcp-server-starrocks --mode streamable-http --host 0.0.0.0 --port 8080
# Start in stdio mode (default)
uv run mcp-server-starrocks --mode stdio
# Run test mode
uv run mcp-server-starrocks --test
- O campo
urldeve apontar para o endpoint HTTP Transmissível do seu servidor MCP (ajuste host/porta conforme necessário). - Com esta configuração, os clientes podem interagir com o servidor usando JSON padrão por meio de solicitações HTTP POST. Nenhum SDK especial é necessário.
- Todas as APIs de ferramentas aceitam e retornam JSON padrão conforme descrito acima.
Nota: O modo
sse(Eventos Enviados pelo Servidor) está obsoleto e não é mais mantido. Use o modo HTTP Transmissível para todas as novas integrações.
Variáveis de Ambiente:
Configuração de Conexão
Você pode configurar a conexão com o StarRocks usando variáveis de ambiente individuais ou uma única URL de conexão:
Opção 1: Variáveis de Ambiente Individuais
STARROCKS_HOST: (Opcional) Nome do host ou endereço IP do serviço FE do StarRocks. O padrão élocalhost.STARROCKS_PORT: (Opcional) Porta do protocolo MySQL do serviço FE do StarRocks. O padrão é9030.STARROCKS_USER: (Opcional) Nome de usuário do StarRocks. O padrão éroot.STARROCKS_PASSWORD: (Opcional) Senha do StarRocks. O padrão é string vazia.STARROCKS_PASSWORD_KEYCHAIN_SERVICE: (Opcional, somente macOS) Nome do serviço de senha genérica a ser usado ao ler a senha do Keychain. Isso só é usado quando nenhuma senha explícita é fornecida viaSTARROCKS_PASSWORDouSTARROCKS_URL.STARROCKS_PASSWORD_KEYCHAIN_ACCOUNT: (Opcional, somente macOS) Nome da conta de senha genérica a ser usado ao ler a senha do Keychain. O padrão é o usuário resolvido do StarRocks.STARROCKS_DB: (Opcional) Banco de dados padrão a ser usado se não for especificado nos argumentos da ferramenta ou URIs de recurso. Se definido, a conexão tentará executarUSEneste banco de dados. Ferramentas comotable_overviewedb_overviewusarão isso se a parte do banco de dados for omitida em seus argumentos. O padrão é vazio (sem banco de dados padrão).
Opção 2: URL de Conexão (tem precedência sobre variáveis individuais)
-
STARROCKS_URL: (Opcional) Uma string de URL de conexão que contém todos os parâmetros de conexão em uma única variável. Formato:[<schema>://]user:password@host:port/database. A parte do esquema é opcional. Quando esta variável é definida, ela tem precedência sobre as variáveis individuaisSTARROCKS_HOST,STARROCKS_PORT,STARROCKS_USER,STARROCKS_PASSWORDeSTARROCKS_DB.Exemplos:
root:mypass@localhost:9030/test_dbmysql://admin:secret@db.example.com:9030/productionstarrocks://user:pass@192.168.1.100:9030/analytics
Precedência de senha:
- Uma senha incorporada em
STARROCKS_URLprevalece, incluindo uma senha vazia explícita comouser:@host:9030/db. - Se
STARROCKS_URLomitir a senha,STARROCKS_PASSWORDserá usado quando definido. - Se nenhuma fonte de senha explícita for definida e
STARROCKS_PASSWORD_KEYCHAIN_SERVICEestiver configurado, a senha será lida do Keychain do macOS.
Exemplo do Keychain do macOS
Armazene a senha:
security add-generic-password -U -a root -s mcp-server-starrocks -w 'secret'
Verifique a senha armazenada:
security find-generic-password -a root -s mcp-server-starrocks -w
Use-a com este servidor:
export STARROCKS_URL=root@localhost:9030/test_db
export STARROCKS_PASSWORD_KEYCHAIN_SERVICE=mcp-server-starrocks
export STARROCKS_PASSWORD_KEYCHAIN_ACCOUNT=root
Configuração Adicional
-
STARROCKS_FE_ARROW_FLIGHT_SQL_PORT: (Opcional) Porta Arrow Flight SQL do serviço FE do StarRocks. Quando definida, o servidor conecta-se usando o protocolo Arrow Flight SQL de alto desempenho (via drivers ADBC) em vez do protocolo MySQL padrão. Deixe indefinido para usar a conexão MySQL padrão. O host, usuário e senha são obtidos das mesmas configurações de conexão descritas acima. -
STARROCKS_OVERVIEW_LIMIT: (Opcional) Um limite aproximado de caracteres para o texto total gerado pelas ferramentas de visão geral (table_overview,db_overview) ao buscar dados para preencher o cache. Isso ajuda a evitar o uso excessivo de memória para esquemas muito grandes ou tabelas numerosas. O padrão é20000. -
STARROCKS_MCP_OUTPUT_DIR: (Opcional) Diretório usado porread_queryquando seu argumentooutput_fileé um caminho relativo. O padrão é~/.mcp-server-starrocks/output/. O diretório é criado sob demanda. Caminhos absolutos passados paraoutput_file(incluindo caminhos prefixados com~) ignoram esta configuração. Nota: os arquivos são gravados na máquina onde o servidor MCP é executado. Para Claude Code / Claude Desktop, o servidor é executado localmente, então os arquivos ficam no seu laptop. Para implantações remotas/http, o arquivo fica no servidor, não no cliente. -
STARROCKS_CHART_OUTPUT_DIR: (Opcional) Diretório ondequery_and_plotly_chartgrava gráficos HTML interativos (quandoformat="html"). O padrão é o diretório temporário do sistema. O diretório é criado sob demanda. Nota: como outros arquivos de saída, os gráficos são gravados na máquina onde o servidor MCP é executado. -
STARROCKS_CHART_INCLUDE_PLOTLYJS: (Opcional) Controla comoplotly.jsé empacotado em gráficos HTML.cdn(padrão) mantém os arquivos pequenos, mas precisa de acesso à rede ao visualizar;inline/trueincorpora a biblioteca completa para uso offline;directoryefalsetambém são aceitos (repassados para owrite_htmldo Plotly). -
STARROCKS_CHART_DEFAULT_FORMAT: (Opcional) Formato de saída padrão paraquery_and_plotly_chartquando o argumentoformaté omitido. Um dejson,png,jpeg(padrão) ouhtml. Defina comohtmlpara sempre gravar um arquivo de gráfico interativo emSTARROCKS_CHART_OUTPUT_DIR(com uma pré-visualização PNG inline) sem passarformatem cada chamada. Valores inválidos retornam parajpegcom um aviso. -
STARROCKS_MYSQL_AUTH_PLUGIN: (Opcional) Especifica o plugin de autenticação a ser usado ao conectar-se ao serviço FE do StarRocks. Por exemplo, defina comomysql_clear_passwordse sua implantação do StarRocks exigir autenticação de senha em texto claro (como ao usar certas configurações LDAP ou de autenticação externa). Defina isso apenas se seu ambiente exigir especificamente; caso contrário, o auth_plugin padrão será usado.
Configuração TLS / SSL
Essas variáveis controlam o TLS para a conexão. Quando nenhuma delas é definida, o mysql.connector subjacente mantém seu comportamento padrão (ssl-mode=PREFERRED): a conexão é criptografada se o servidor suportar TLS, mas o certificado do servidor não é verificado. Para segurança real, forneça um certificado CA e habilite a verificação.
STARROCKS_SSL_DISABLED: (Opcional) Defina comotruepara forçar a desativação do TLS. Substitui todas as outras configurações SSL. O padrão éfalse.STARROCKS_SSL_CA: (Opcional) Caminho para o certificado CA (PEM) usado para verificar o certificado do servidor StarRocks.STARROCKS_SSL_CERT: (Opcional) Caminho para o certificado do cliente (PEM) para TLS mútuo (mTLS).STARROCKS_SSL_KEY: (Opcional) Caminho para a chave privada do cliente (PEM) para TLS mútuo (mTLS).STARROCKS_SSL_VERIFY_CERT: (Opcional) Defina comotruepara verificar o certificado do servidor em relação à CA. O padrão éfalse.STARROCKS_SSL_VERIFY_IDENTITY: (Opcional) Defina comotruepara verificar também se o nome do host do servidor corresponde ao certificado. O padrão éfalse.STARROCKS_TLS_VERSIONS: (Opcional) Lista separada por vírgulas de versões TLS permitidas, por exemplo,TLSv1.2,TLSv1.3.
Exemplo (verificar o servidor em relação a um certificado CA):
"env": {
"STARROCKS_HOST": "your-fe-host",
"STARROCKS_PORT": "9030",
"STARROCKS_USER": "root",
"STARROCKS_PASSWORD": "your-password",
"STARROCKS_SSL_CA": "/path/to/ca.pem",
"STARROCKS_SSL_VERIFY_CERT": "true",
"STARROCKS_SSL_VERIFY_IDENTITY": "true"
}
Para a conexão de alto desempenho Arrow Flight SQL (habilitada via STARROCKS_FE_ARROW_FLIGHT_SQL_PORT), o TLS é controlado separadamente:
STARROCKS_FE_ARROW_FLIGHT_SQL_USE_TLS: (Opcional) Defina comotruepara usargrpc+tls://em vez de texto simplesgrpc://. Quando habilitado,STARROCKS_SSL_CAé usado como o certificado raiz TLS eSTARROCKS_SSL_VERIFY_CERT=false(padrão) ignora a verificação do certificado do servidor.
Nota de segurança: evite armazenar senhas em texto simples diretamente em
mcp.json. Prefira injetarSTARROCKS_PASSWORD(e caminhos de certificado) de um gerenciador de segredos ou ambiente, e nunca faça commit de credenciais no controle de versão.
MCP_TRANSPORT_MODE: (Opcional) Modo de comunicação que especifica como o Servidor MCP expõe seus serviços. Opções disponíveis:stdio(padrão): Comunica-se através de entrada/saída padrão, adequado para hospedagem de Host MCP.streamable-http(HTTP Transmissível): Inicia como um Servidor HTTP Transmissível, suportando chamadas de API RESTful.sse: (Obsoleto, não recomendado) Inicia no modo de streaming de Eventos Enviados pelo Servidor (SSE), adequado para cenários que exigem respostas de streaming. Nota: O modo SSE não é mais mantido, recomenda-se usar o modo HTTP Transmissível uniformemente.
Componentes
Ferramentas
-
read_query- Descrição: Executa uma consulta SELECT ou outros comandos que retornam um ResultSet (ex.,
SHOW,DESCRIBE). Opcionalmente, grava o resultado completo em um arquivo local em vez de retorná-lo inline — útil para resultados grandes demais para caber no contexto do modelo. - Entrada:
{ "query": "SQL query string", "db": "database name (optional, uses default database if not specified)", "output_file": "optional path; if set, writes the full result to disk and returns only a summary + small preview. Relative paths resolve against STARROCKS_MCP_OUTPUT_DIR (default: ~/.mcp-server-starrocks/output/); absolute paths and ~ are used as-is", "output_format": "optional: csv | tsv | json | jsonl. If omitted, inferred from output_file extension (.csv/.tsv/.json/.jsonl/.ndjson); defaults to csv" } - Saída: Sem
output_file, conteúdo de texto contendo os resultados da consulta em formato similar a CSV com uma linha de cabeçalho e resumo da contagem de linhas. Comoutput_file, um breve resumo incluindo o caminho absoluto resolvido, contagem de bytes e contagem de linhas, além de uma pequena prévia. Retorna uma mensagem de erro em caso de falha.
- Descrição: Executa uma consulta SELECT ou outros comandos que retornam um ResultSet (ex.,
-
write_query- Descrição: Executa um comando DDL (
CREATE,ALTER,DROP), DML (INSERT,UPDATE,DELETE) ou outro comando do StarRocks que não retorna um ResultSet. - Entrada:
{ "query": "SQL command string", "db": "database name (optional, uses default database if not specified)" } - Saída: Conteúdo de texto confirmando o sucesso (ex., "Query OK, X rows affected") ou reportando um erro. As alterações são confirmadas automaticamente em caso de sucesso.
- Descrição: Executa um comando DDL (
-
analyze_query- Descrição: Analisa uma consulta e obtém o resultado da análise usando perfil de consulta ou explain analyze.
- Entrada:
{ "uuid": "Query ID, a string composed of 32 hexadecimal digits formatted as 8-4-4-4-12", "sql": "Query SQL to analyze", "db": "database name (optional, uses default database if not specified)" } - Saída: Conteúdo de texto contendo os resultados da análise da consulta. Usa
ANALYZE PROFILE FROMse uuid for fornecido, caso contrário usaEXPLAIN ANALYZEse sql for fornecido.
-
top_hot_tables- Descrição: Obtém as principais tabelas quentes por contagem de visitas no log de auditoria. Faz a junção de
information_schema.tablescomstarrocks_audit_db__.starrocks_audit_tbl__, exclui instruçõesrooteSHOW, cruza o texto SQL de auditoria com os nomes das tabelas e ordena porvisit_countdecrescente. - Entrada:
{ "db": "optional database/schema filter", "table": "optional table name substring filter", "min_start_time_ms": 1704067200000, "max_start_time_ms": 1704153600000, "top_n": 20 } - Saída: Resumo em texto mais conteúdo estruturado contendo linhas classificadas com
db,tableevisit_count.
- Descrição: Obtém as principais tabelas quentes por contagem de visitas no log de auditoria. Faz a junção de
-
top_bad_tables- Descrição: Obtém as principais tabelas problemáticas por pontuação de saúde da tabela, seguindo a lógica
top-bad-tablesdo Star Management Studio. Reutiliza o cálculo de saúde da tabela baseado eminformation_schema.be_tabletseinformation_schema.partitions_meta, filtra esquemas de sistema, ordena portable_health_scoreascendente e retorna as tabelas com menor pontuação. - Entrada:
{ "db": "optional database/schema filter", "table": "optional table name substring filter", "top_n": 20 } - Saída: Resumo em texto mais conteúdo estruturado contendo linhas classificadas com campos de saúde da tabela, como
db,table,tablet_num,replica_score,tablet_scoreetable_health_score.
- Descrição: Obtém as principais tabelas problemáticas por pontuação de saúde da tabela, seguindo a lógica
-
query_and_plotly_chart- Descrição: Executa uma consulta SQL, carrega os resultados em um DataFrame do Pandas e gera um gráfico Plotly usando uma expressão Python fornecida. Projetado para visualização em UIs compatíveis.
- Entrada:
{ "query": "SQL query to fetch data", "plotly_expr": "Python expression string using 'px' (Plotly Express) and 'df' (DataFrame). Example: 'px.scatter(df, x=\"col1\", y=\"col2\")'", "db": "database name (optional, uses default database if not specified)" } - Saída: Uma lista contendo:
TextContent: Uma representação textual do DataFrame e uma nota de que o gráfico é para exibição na UI.ImageContent: O gráfico Plotly gerado, codificado como uma imagem PNG base64 (image/png). Retorna uma mensagem de erro em texto em caso de falha ou se a consulta não produzir dados.
-
table_overview- Descrição: Obtém uma visão geral de uma tabela específica: colunas (de
DESCRIBE), contagem total de linhas e linhas de amostra (LIMIT 3). Usa um cache em memória, a menos querefreshseja true. - Entrada:
{ "table": "Table name, optionally prefixed with database name (e.g., 'db_name.table_name' or 'table_name'). If database is omitted, uses STARROCKS_DB environment variable if set.", "refresh": false // Optional, boolean. Set to true to bypass the cache. Defaults to false. } - Saída: Conteúdo de texto contendo a visão geral formatada (colunas, contagem de linhas, dados de amostra) ou uma mensagem de erro. Resultados em cache incluem erros anteriores, se aplicável.
- Descrição: Obtém uma visão geral de uma tabela específica: colunas (de
-
db_overview- Descrição: Obtém uma visão geral (colunas, contagem de linhas, linhas de amostra) para todas as tabelas dentro de um banco de dados especificado. Usa o cache em nível de tabela para cada tabela, a menos que
refreshseja true. - Entrada:
{ "db": "database_name", // Optional if default database is set. "refresh": false // Optional, boolean. Set to true to bypass the cache for all tables in the DB. Defaults to false. } - Saída: Conteúdo de texto contendo visões gerais concatenadas para todas as tabelas encontradas no banco de dados, separadas por cabeçalhos. Retorna uma mensagem de erro se o banco de dados não puder ser acessado ou não contiver tabelas.
- Descrição: Obtém uma visão geral (colunas, contagem de linhas, linhas de amostra) para todas as tabelas dentro de um banco de dados especificado. Usa o cache em nível de tabela para cada tabela, a menos que
Recursos
Recursos Diretos
starrocks:///databases- Descrição: Lista todos os bancos de dados acessíveis ao usuário configurado.
- Consulta Equivalente:
SHOW DATABASES - Tipo MIME:
text/plain
Modelos de Recursos
-
starrocks:///{db}/{table}/schema- Descrição: Obtém a definição do esquema de uma tabela específica.
- Consulta Equivalente:
SHOW CREATE TABLE {db}.{table} - Tipo MIME:
text/plain
-
starrocks:///{db}/tables- Descrição: Lista todas as tabelas dentro de um banco de dados específico.
- Consulta Equivalente:
SHOW TABLES FROM {db} - Tipo MIME:
text/plain
-
proc:///{+path}- Descrição: Acessa informações internas do sistema StarRocks, similar ao
/procdo Linux. O parâmetropathespecifica o nó de informação desejado. - Consulta Equivalente:
SHOW PROC '/{path}' - Tipo MIME:
text/plain - Caminhos Comuns:
/frontends- Informações sobre nós FE./backends- Informações sobre nós BE (para implantações não nativas em nuvem)./compute_nodes- Informações sobre nós CN (para implantações nativas em nuvem)./dbs- Informações sobre bancos de dados./dbs/<DB_ID>- Informações sobre um banco de dados específico por ID./dbs/<DB_ID>/<TABLE_ID>- Informações sobre uma tabela específica por ID./dbs/<DB_ID>/<TABLE_ID>/partitions- Informações de partição para uma tabela./transactions- Informações de transação agrupadas por banco de dados./transactions/<DB_ID>- Informações de transação para um ID de banco de dados específico./transactions/<DB_ID>/running- Transações em execução para um ID de banco de dados./transactions/<DB_ID>/finished- Transações concluídas para um ID de banco de dados./jobs- Informações sobre jobs assíncronos (Schema Change, Rollup, etc.)./statistic- Estatísticas para cada banco de dados./tasks- Informações sobre tarefas de agente./cluster_balance- Informações de status de balanceamento de carga./routine_loads- Informações sobre jobs de Routine Load./colocation_group- Informações sobre grupos de Colocation Join./catalog- Informações sobre catálogos configurados (ex., Hive, Iceberg).
- Descrição: Acessa informações internas do sistema StarRocks, similar ao
Prompts
Nenhum definido por este servidor.
Comportamento de Cache
- As ferramentas
table_overviewedb_overviewutilizam um cache em memória para armazenar o texto de visão geral gerado. - A chave do cache é uma tupla de
(database_name, table_name). - Quando
table_overviewé chamada, ela verifica o cache primeiro. Se um resultado existir e o parâmetrorefreshforfalse(padrão), o resultado em cache é retornado imediatamente. Caso contrário, busca os dados do StarRocks, armazena-os no cache e então os retorna. - Quando
db_overviewé chamada, ela lista todas as tabelas no banco de dados e então tenta recuperar a visão geral para cada tabela usando a mesma lógica de cache quetable_overview(verificando o cache primeiro, buscando se necessário erefreshforfalseou se não houver cache). Serefreshfortrueparadb_overview, força uma atualização para todas as tabelas naquele banco de dados. - A variável de ambiente
STARROCKS_OVERVIEW_LIMITfornece um limite flexível para o comprimento máximo da string de visão geral gerada por tabela ao preencher o cache, ajudando a gerenciar o uso de memória. - Resultados em cache, incluindo quaisquer mensagens de erro encontradas durante a busca original, são armazenados e retornados em acessos subsequentes ao cache.
Depuração
Após iniciar o servidor mcp, você pode usar o inspetor para depurar:
npx @modelcontextprotocol/inspector
Demonstração

