Atlan

Servidor MCP Atlan

[!WARNING] Este servidor MCP local está obsoleto. Use o MCP Atlan hospedado em mcp.atlan.com/mcp.

O caminho de instalação local (Docker, uv ou pip install atlan-mcp-server) está em modo apenas de manutenção — sem novos recursos, suporte não garantido. O endpoint hospedado é a maneira recomendada de integrar o Atlan com Claude Desktop, Cursor, Codex, Databricks UC e outros clientes MCP. Consulte a visão geral do Atlan MCP para configuração.

O servidor Model Context Protocol da Atlan permite que seus agentes de IA interajam com os serviços da Atlan.

Início Rápido

1. Gere uma chave de API da Atlan seguindo a documentação.
2. Selecione uma das seguintes abordagens com base na sua preferência:
   • Instalar via Docker - Usa contêineres Docker (recomendado)
   • Instalar via uv - Usa o gerenciador de pacotes UV

[!NOTE] Certifique-se de substituir <YOUR_API_KEY>, <YOUR_INSTANCE> e <YOUR_AGENT_ID> pela sua chave de API da Atlan, URL da instância e ID do agente (opcional) no arquivo de configuração, respectivamente.

Instalar via Docker

Pré-requisitos:

• Siga o guia oficial de instalação do Docker para o seu sistema operacional
• Verifique se o Docker está em execução:

  docker --version
  

Adicionar ao Claude Desktop

Vá para Claude > Settings > Developer > Edit Config > claude_desktop_config.json e adicione:

{
  "mcpServers": {
    "atlan": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ATLAN_API_KEY=<YOUR_API_KEY>",
        "-e",
        "ATLAN_BASE_URL=https://<YOUR_INSTANCE>.atlan.com",
        "-e",
        "ATLAN_AGENT_ID=<YOUR_AGENT_ID>",
        "ghcr.io/atlanhq/atlan-mcp-server:latest"
      ]
    }
  }
}

Adicionar ao Cursor

Abra Cursor > Settings > Tools & Integrations > New MCP Server para incluir o seguinte:

{
  "mcpServers": {
    "atlan": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ATLAN_API_KEY=<YOUR_API_KEY>",
        "-e",
        "ATLAN_BASE_URL=https://<YOUR_INSTANCE>.atlan.com",
        "-e",
        "ATLAN_AGENT_ID=<YOUR_AGENT_ID>",
        "ghcr.io/atlanhq/atlan-mcp-server:latest"
      ]
    }
  }
}

Instalar via uv

Pré-requisitos:

• Instale o uv:

  # macOS/Linux
  curl -LsSf https://astral.sh/uv/install.sh | sh
  
  # Windows (PowerShell)
  powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
  
  # Alternative: if you already have Python/pip
  pip install uv
  

• Verifique a instalação:

  uv --version
  

[!NOTE] Com o uv, uvx busca automaticamente a versão mais recente cada vez que você o executa. Para um comportamento mais previsível, considere usar a opção Docker.

Adicionar ao Claude Desktop

Vá para Claude > Settings > Developer > Edit Config > claude_desktop_config.json para incluir o seguinte:

{
  "mcpServers": {
    "atlan": {
      "command": "uvx",
      "args": ["atlan-mcp-server"],
      "env": {
        "ATLAN_API_KEY": "<YOUR_API_KEY>",
        "ATLAN_BASE_URL": "https://<YOUR_INSTANCE>.atlan.com",
        "ATLAN_AGENT_ID": "<YOUR_AGENT_ID>"
      }
    }
  }
}

Adicionar ao Cursor

Abra Cursor > Settings > Tools & Integrations > New MCP Server para incluir o seguinte:

{
  "mcpServers": {
    "atlan": {
      "command": "uvx",
      "args": ["atlan-mcp-server"],
      "env": {
        "ATLAN_API_KEY": "<YOUR_API_KEY>",
        "ATLAN_BASE_URL": "https://<YOUR_INSTANCE>.atlan.com",
        "ATLAN_AGENT_ID": "<YOUR_AGENT_ID>"
      }
    }
  }
}

Ferramentas Disponíveis

Ferramenta	Descrição
search_assets	Pesquisar ativos com base em condições
get_assets_by_dsl	Recuperar ativos usando uma consulta DSL
traverse_lineage	Recuperar linhagem de um ativo
update_assets	Atualizar atributos de ativos (descrição do usuário e status do certificado)
create_glossaries	Criar glossários
create_glossary_categories	Criar categorias de glossário
create_glossary_terms	Criar termos de glossário
create_dq_rules	Criar regras de qualidade de dados em ativos Table, View, MaterialisedView ou SnowflakeDynamicTable (nível de coluna, nível de tabela, SQL personalizado)
update_dq_rules	Atualizar regras de qualidade de dados existentes (limite, prioridade, condições, etc.)
schedule_dq_rules	Agendar execução de regras de qualidade de dados para ativos usando expressões cron
delete_dq_rules	Excluir uma ou várias regras de qualidade de dados por GUID
query_asset	Executar consultas SQL em ativos de tabela/view

Controle de Acesso a Ferramentas

O Servidor MCP Atlan inclui um middleware configurável de restrição de ferramentas que permite controlar quais ferramentas estão disponíveis para os usuários. Isso é útil para implementar controle de acesso baseado em funções ou restringir certas operações em ambientes específicos.

Restringindo Ferramentas

Você pode restringir o acesso a ferramentas específicas usando a variável de ambiente RESTRICTED_TOOLS. Forneça uma lista separada por vírgulas dos nomes das ferramentas que devem ser bloqueadas:

Configuração Docker

{
  "mcpServers": {
    "atlan": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ATLAN_API_KEY=<YOUR_API_KEY>",
        "-e",
        "ATLAN_BASE_URL=https://<YOUR_INSTANCE>.atlan.com",
        "-e",
        "ATLAN_AGENT_ID=<YOUR_AGENT_ID>",
        "-e",
        "RESTRICTED_TOOLS=get_assets_by_dsl_tool,update_assets_tool",
        "ghcr.io/atlanhq/atlan-mcp-server:latest"
      ]
    }
  }
}

Configuração uv

{
  "mcpServers": {
    "atlan": {
      "command": "uvx",
      "args": ["atlan-mcp-server"],
      "env": {
        "ATLAN_API_KEY": "<YOUR_API_KEY>",
        "ATLAN_BASE_URL": "https://<YOUR_INSTANCE>.atlan.com",
        "ATLAN_AGENT_ID": "<YOUR_AGENT_ID>",
        "RESTRICTED_TOOLS": "get_assets_by_dsl_tool,update_assets_tool"
      }
    }
  }
}

Nomes de Ferramentas Disponíveis para Restrição

Você pode restringir qualquer uma das seguintes ferramentas:

• search_assets_tool - Funcionalidade de pesquisa de ativos
• get_assets_by_dsl_tool - Execução de consulta DSL
• traverse_lineage_tool - Travessia de linhagem
• update_assets_tool - Atualizações de ativos (descrições, certificados)
• create_glossaries - Criação de glossário
• create_glossary_categories - Criação de categoria
• create_glossary_terms - Criação de termo
• create_dq_rules_tool - Criação de regra de qualidade de dados
• update_dq_rules_tool - Atualizações de regra de qualidade de dados
• schedule_dq_rules_tool - Agendamento de regra de qualidade de dados
• delete_dq_rules_tool - Exclusão de regra de qualidade de dados

Casos de Uso Comuns

Acesso Somente Leitura

Restringir todas as operações de escrita:

RESTRICTED_TOOLS=update_assets_tool,create_glossaries,create_glossary_categories,create_glossary_terms,create_dq_rules_tool,update_dq_rules_tool,schedule_dq_rules_tool,delete_dq_rules_tool

Desabilitar Consultas DSL

Por razões de segurança ou desempenho:

RESTRICTED_TOOLS=get_assets_by_dsl_tool

Acesso Mínimo

Permitir apenas pesquisa básica:

RESTRICTED_TOOLS=get_assets_by_dsl_tool,update_assets_tool,traverse_lineage_tool,create_glossaries,create_glossary_categories,create_glossary_terms,create_dq_rules_tool,update_dq_rules_tool,schedule_dq_rules_tool,delete_dq_rules_tool

Como Funciona

Quando as ferramentas são restritas:

1. Ocultas das listagens: Ferramentas restritas não aparecerão quando os clientes solicitarem as ferramentas disponíveis
2. Execução bloqueada: Se alguém tentar executar uma ferramenta restrita, receberá uma mensagem de erro clara
3. Registrado: Todas as decisões de acesso são registradas para monitoramento e depuração

Sem Restrições (Padrão)

Se você não definir a variável de ambiente RESTRICTED_TOOLS, todas as ferramentas estarão disponíveis por padrão.

Modos de Transporte

O Servidor MCP Atlan suporta três modos de transporte, cada um otimizado para diferentes cenários de implantação. Para mais detalhes sobre os modos de transporte MCP, consulte a documentação oficial do MCP.

Modo de Transporte	Caso de Uso	Benefícios	Quando Usar
stdio (Padrão)	Desenvolvimento local, integrações IDE	Simples, comunicação direta	Claude Desktop, Cursor IDE
SSE (Server-Sent Events)	Implantações remotas, navegadores web	Streaming em tempo real, compatível com web	Implantações em nuvem, clientes web
streamable-http	Conexões remotas baseadas em HTTP	HTTP padrão, amigável a balanceadores de carga	Kubernetes, implantações em contêineres

Para instruções abrangentes de implantação, exemplos de configuração e melhores práticas de produção, consulte nosso Guia de Implantação.

Implantação em Produção

• Hospede a imagem do contêiner Atlan MCP na nuvem/plataforma de sua escolha
• Certifique-se de adicionar todas as variáveis de ambiente necessárias
• Escolha o modo de transporte apropriado para o seu cenário de implantação. O Transporte SSE é recomendado para produção (-e MCP_TRANSPORT=sse)
• Para cenários e configurações de implantação detalhados, consulte o Guia de Implantação

Configuração MCP Remota

Atualmente, não temos um servidor MCP remoto para Atlan disponível publicamente.

Você pode usar a ferramenta de proxy local mcp-remote para conectá-lo ao seu servidor MCP remoto.

Isso permite que você teste como será uma interação com seu servidor MCP remoto com um cliente MCP do mundo real.

{
  "mcpServers": {
    "math": {
      "command": "npx",
      "args": ["mcp-remote", "https://hosted-domain"]
    }
  }
}

Desenvolver Localmente

Quer desenvolver localmente? Confira nosso Guia de Build Local para um passo a passo!

Precisa de Ajuda?

• Entre em contato com support@atlan.com para qualquer dúvida ou feedback
• Você também pode criar diretamente uma issue no GitHub e nós responderemos

Perguntas Frequentes

Preciso ter o Python instalado?

Resposta curta: Depende do seu método de instalação.

• Docker (Recomendado): Não é necessária instalação do Python na sua máquina host. O contêiner inclui tudo o que é necessário.
• uv: Um runtime Python é necessário, mas o uv fará o download e gerenciará automaticamente o Python 3.11+ para você se ainda não estiver disponível.

Detalhes técnicos: O servidor MCP Atlan é implementado como uma aplicação Python. O próprio Model Context Protocol é independente de linguagem, mas nossa implementação atual requer Python 3.11+ para executar.

Solução de Problemas

1. Se o Claude Desktop mostrar um erro semelhante a spawn uv ENOENT {"context":"connection","stack":"Error: spawn uv ENOENT\n at ChildProcess._handle.onexit, provavelmente é este problema em que o Claude não consegue encontrar o uv. Para corrigi-lo:
   • Certifique-se de que o uv está instalado e disponível no seu PATH
   • Execute which uv para verificar o caminho de instalação
   • Atualize a configuração do Claude para apontar para o caminho exato do uv executando whereis uv e use esse caminho