DX MCP Server

Consulte seus dados organizacionais no DX Data Cloud usando linguagem natural.

Documentação

DX MCP Server

Use linguagem natural para escrever e executar consultas nos dados organizacionais do seu DX Data Cloud!

AI Query Interface with DX MCP Server

Sobre

O DX MCP Server é uma ferramenta baseada em Python que capacita aplicações de IA, como Claude for Desktop e Cursor, a interagir com o seu banco de dados DX Data Cloud. O servidor inclui ferramentas para:

  • estabelecer uma conexão com o seu banco de dados Postgres, permitindo que a IA formule e execute consultas ativamente no banco de dados
  • encontrar/utilizar contexto sobre suas entidades de software e seus relacionamentos e scorecards por meio das ferramentas de catálogo da DX

Saiba mais sobre o Model Context Protocol (MCP).

Nota: A DX pretende que o CLI se torne a interface principal para agentes de IA e está investindo nele como direção de longo prazo além do servidor MCP. Ambas as interfaces continuam suportadas.

Demonstração

https://github.com/user-attachments/assets/c6ce12a5-4562-4b44-b235-2d04871c3142

Primeiros Passos

Há duas maneiras de usar o DX MCP Server:

  1. Hospedagem remota (recomendada): Conecte-se ao nosso servidor hospedado em https://ai.getdx.com/mcp
  2. Hospedagem local: Execute o servidor na sua máquina

Pré-requisitos

  • Uma conta DX com acesso ao Data Cloud

  • Para hospedagem remota:

    • Um token de API da DX, gerado nas suas Configurações da Conta DX
      • Usuários administradores podem criar um token de API da organização com escopos de leitura concedidos, e usuários não administradores podem gerar tokens de acesso pessoal para autenticar com o servidor MCP.
  • Para hospedagem local:

    • Python 3.10 ou superior
    • Sua URL de conexão com o banco de dados (configurada na página de Configurações de Usuários de DB da DX)
    • Um token de API da DX, gerado nas suas Configurações da Conta DX
      • Usuários administradores podem criar um token de API da organização com escopos de leitura concedidos, e usuários não administradores podem gerar tokens de acesso pessoal para autenticar com o servidor MCP.

Opção 1: Hospedagem Remota (Recomendada)

O servidor MCP hospedado usa transporte HTTP transmissível e está disponível em https://ai.getdx.com/mcp. Esta opção não requer instalação local; basta configurar seu cliente de IA com o MCP usando transporte http e fornecer um token de API da DX válido.

Claude Code

Execute este comando no seu terminal:

claude mcp add --transport http dx-mcp https://ai.getdx.com/mcp --header "Authorization: Bearer [YOUR_DX_API_TOKEN]"

Cursor

Adicione esta configuração às suas configurações de MCP (Cursor > Settings > Cursor Settings > MCP):

{
  "mcpServers": {
    "dx-mcp": {
      "url": "https://ai.getdx.com/mcp",
      "headers": {
        "Authorization": "Bearer [YOUR_DX_API_TOKEN]"
      }
    }
  }
}

Opção 2: Instalação Local

Se você preferir executar o DX MCP Server localmente, pode instalá-lo via PyPI ou executá-lo a partir do código-fonte.

Método de Instalação 1: Instalar a partir do PyPI

Instale o pacote usando pip:

pip install dx-mcp-server

Nota para usuários de macOS: Se você encontrar um erro de "externally-managed-environment", use pipx em vez disso:

pipx install dx-mcp-server

Método de Instalação 2: Clonar a partir do Código-Fonte

Clone este repositório para executar a partir do código-fonte:

git clone https://github.com/get-dx/dx-mcp-server
cd dx-mcp-server

Configuração

Após a instalação, configure seu cliente de IA com as configurações apropriadas:

Claude Code

Execute este comando no seu terminal (ajuste com base no seu método de instalação):

# If installed via pip/pipx
claude mcp add dx-mcp-server --env DB_URL=YOUR_DB_URL --env WEB_API_TOKEN=YOUR_DX_API_TOKEN -- $(which dx-mcp-server)

Claude for Desktop

Clique em Claude > Settings > Developer > Edit Config e adicione:

Se você instalou via pip:

{
  "mcpServers": {
    "dx-mcp": {
      "command": "dx-mcp-server", 
      "args": ["run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR_DX_API_TOKEN"
      }
    }
  }
}

Se você está executando a partir do código-fonte:

{
  "mcpServers": {
    "dx-mcp": {
      "command": "uv",
      "args": ["--directory", "/path/to/dx-mcp-server", "run", "-m", "dx_mcp_server", "run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

Cursor

Clique em Cursor > Settings > Cursor Settings > MCP > Add new global MCP Server e adicione:

Se você instalou via pip:

{
  "mcpServers": {
    "dx-mcp": {
      "command": "dx-mcp-server", 
      "args": ["run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

Se você está executando a partir do código-fonte:

{
  "mcpServers": {
    "dx-mcp": {
      "command": "uv",
      "args": ["--directory", "/path/to/dx-mcp-server", "run", "-m", "dx_mcp_server", "run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

Parâmetros de Configuração

  • DB_URL (obrigatório): Sua string de conexão Postgres do DX Data Cloud. Obtenha isso nas configurações de Usuários de DB da DX.
    • Formato: postgresql://username:password@host:port/database
  • WEB_API_TOKEN: Seu token de API da DX (um token de organização ou um token de acesso pessoal). Isso habilita ferramentas adicionais de catálogo e entidades. Encontre isso nas configurações da sua conta DX.

Uso

Após salvar a configuração, reinicie seu cliente de IA. Você deve ver "dx-mcp" nos servidores MCP disponíveis. Quando você fizer perguntas sobre seus dados ou catálogo, a IA usará essas ferramentas para consultar seu banco de dados ou acessar as APIs web relevantes.


Solução de Problemas

Problemas de Resolução de Caminho

O problema mais comum envolve o cliente MCP não encontrar o comando dx-mcp-server/uv, pois aplicações GUI não herdam as mesmas variáveis de ambiente PATH que o terminal. A solução é usar o caminho completo para o executável na configuração json.

Para instalações via pip/pipx:

Encontre o caminho completo para dx-mcp-server:

# Find the path on macOS/Linux
which dx-mcp-server

# Find the path on Windows (in Command Prompt)
where dx-mcp-server

Em seguida, use o caminho completo na sua configuração:

{
  "mcpServers": {
    "dx-mcp": {
      "command": "/full/path/to/dx-mcp-server",
      "args": ["run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

Para instalações a partir do código-fonte:

Encontre o caminho completo para uv:

# Find the path on macOS/Linux
which uv

# Find the path on Windows (in Command Prompt)
where uv

Em seguida, use o caminho completo na sua configuração:

{
  "mcpServers": {
    "dx-mcp": {
      "command": "/full/path/to/uv",
      "args": ["--directory", "/absolute/path/to/dx-mcp-server", "run", "-m", "dx_mcp_server", "run"],
      "env": {
        "DB_URL": "YOUR-DATABASE-URL",
        "WEB_API_TOKEN": "YOUR-DX-API-TOKEN"
      }
    }
  }
}

Verificando Logs

Se você ainda estiver enfrentando problemas:

  • Claude Desktop: Verifique os logs em:

    • macOS: ~/Library/Logs/Claude/
    • Windows: %APPDATA%\Claude\logs\
  • Cursor: Verifique os logs em:

    • macOS: ~/Library/Application Support/Cursor/logs/[SESSION_ID]
    • Windows: %APPDATA%\Cursor\logs\[SESSION_ID]

Os logs mostrarão mensagens de aviso e erro ao iniciar ou executar o servidor MCP.