Superset MCP Server

Superset MCP Server

Um servidor Model Context Protocol (MCP) para gerenciar datasets, métricas e consultas SQL do Apache Superset.

📖 中文文档

🚀 Recursos

• Gerenciamento de Datasets: Operações CRUD completas para datasets do Superset
• Gerenciamento de Métricas: Crie, atualize e gerencie métricas de datasets
• Colunas Calculadas: Crie e gerencie colunas calculadas para datasets
• Gerenciamento de Gráficos: Visualize e modifique parâmetros de visualização e filtros de gráficos
• Operações de Dashboard: Acesse informações, gráficos e filtros de dashboards
• Execução de Consultas SQL: Execute consultas SQL diretamente pelo Superset
• Integração com Banco de Dados: Liste e gerencie conexões de banco de dados
• Acesso a Recursos: Navegue por datasets, bancos de dados e métricas por meio dos recursos do MCP

📋 Pré-requisitos

• Node.js 18+
• Acesso a uma instância do Apache Superset
• Credenciais válidas do Superset (nome de usuário/senha ou token de acesso)

🛠️ Instalação

Usando com Cursor ou Claude Desktop

1. Adicione à Configuração do MCP

Adicione a seguinte configuração ao seu arquivo de configurações do MCP:

{
  "mcpServers": {
    "superset-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "superset-mcp"
      ],
      "env": {
        "SUPERSET_BASE_URL": "",
        "SUPERSET_USERNAME": "",
        "SUPERSET_PASSWORD": ""
      }
    }
  }
}

2. Variáveis de Ambiente

Configure sua conexão com o Superset atualizando a seção env na configuração do MCP:

"env": {
  "SUPERSET_BASE_URL": "your-superset-url",
  "SUPERSET_USERNAME": "your_username",
  "SUPERSET_PASSWORD": "your_password",
}

Alternativa: Usando Token de Acesso

"env": {
  "SUPERSET_BASE_URL": "your-superset-url",
  "SUPERSET_ACCESS_TOKEN": "your_access_token"
}

🔧 Ferramentas Disponíveis

Operações de Dataset

Ferramenta	Descrição
list_datasets	Obtém lista paginada de todos os datasets com filtragem e ordenação
get_dataset	Obtém informações detalhadas de um dataset específico
create_dataset	Cria um novo dataset (físico ou virtual com SQL)
update_dataset	Atualiza propriedades de um dataset existente
delete_dataset	Exclui um dataset
refresh_dataset_schema	Atualiza o esquema do dataset a partir do banco de dados de origem
find_and_replace_in_sql	Localiza e substitui texto no SQL de datasets virtuais

Operações de Métricas

Ferramenta	Descrição
get_dataset_metrics	Obtém todas as métricas de um dataset
create_dataset_metric	Cria uma nova métrica com expressão SQL
update_dataset_metric	Atualiza propriedades de uma métrica existente
delete_dataset_metric	Exclui uma métrica

Operações de Colunas Calculadas

Ferramenta	Descrição
get_dataset_columns	Obtém informações de colunas (incluindo colunas calculadas)
create_calculated_column	Cria uma nova coluna calculada com expressão SQL
update_calculated_column	Atualiza uma coluna calculada existente
delete_calculated_column	Exclui uma coluna calculada

Operações de Gráficos

Ferramenta	Descrição
list_charts	Obtém lista paginada de todos os gráficos com filtragem e ordenação
create_chart	Cria um novo gráfico; para a maioria dos tipos de visualização, você deve primeiro chamar get_chart_params para obter o esquema correto de parâmetros
get_chart_params	Obtém o formato de parâmetros obrigatórios para tipos de visualização de gráficos
get_current_chart_config	Obtém detalhes da configuração atual do gráfico (parâmetros de visualização, relacionamentos, propriedade, contexto de consulta)
update_chart	Atualiza propriedades do gráfico, incluindo metadados, fonte de dados e parâmetros de visualização
get_chart_filters	Obtém os filtros de dados atuais aplicados a um gráfico
set_chart_filters	Define filtros de dados para um gráfico (atualiza o gráfico permanentemente)

Operações de Dashboard

Ferramenta	Descrição
list_dashboards	Obtém lista paginada de todos os dashboards com filtragem e ordenação
get_dashboard_charts	Obtém todos os gráficos de um dashboard específico com suas informações
get_dashboard_filters	Obtém a configuração de filtros do dashboard (filtros nativos, filtros globais)
get_dashboard_chart_query_context	Obtém o contexto completo de consulta de um gráfico no dashboard (ID do dataset, métricas usadas com expressões SQL, colunas calculadas, filtros aplicados)
get_dashboard_config	Obtém detalhes do dashboard e configuração incorporada
update_dashboard_config	Atualiza propriedades do dashboard e/ou configuração incorporada
add_chart_to_dashboard	Adiciona um gráfico existente a um dashboard e o posiciona no layout
remove_chart_from_dashboard	Remove um gráfico de um dashboard e limpa seu layout

Operações SQL

Ferramenta	Descrição
execute_sql	Executa consultas SQL com limite de resultados e exibição de dados

Operações de Banco de Dados

Ferramenta	Descrição
list_databases	Obtém todas as conexões de banco de dados configuradas

📚 Recursos

Acesse visões gerais somente leitura por meio dos recursos do MCP:

• superset://datasets - Visão geral de todos os datasets
• superset://databases - Lista de conexões de banco de dados

Exemplos de prompts

Use estes prompts naturais com seu assistente habilitado para MCP; ele escolherá as ferramentas e os argumentos corretos.

• Listar datasets

  • "Mostre os 10 primeiros datasets, começando pelos mais recentemente alterados. Inclua apenas id e table_name."

• Criar um gráfico

  • "Crie um gráfico de tabela simples chamado 'Sample Table' usando o dataset 12."

• Atualizar um gráfico

  • "Altere o gráfico 42 para um gráfico de barras agrupado por país e usando SUM(value)."

• Contexto de consulta do dashboard

  • "No dashboard 'sales-kpi', mostre o contexto completo de consulta do gráfico 101."

• Executar SQL

  • "No banco de dados 3, busque os 10 usuários criados mais recentemente, retornando apenas id e name."