Partilhar via

start comando

Inicie o tempo de execução do construtor da API de dados com um arquivo de configuração existente.

Sintaxe

dab start [options]

Visão rápida

Opção Resumo
-c, --config Use um arquivo de configuração específico (padrão para dab-config.json ou arquivo específico do ambiente, se houver)

Secção da cabeça

Opção Resumo
--LogLevel <level> Especifica o nível de registo como valor fornecido.
--mcp-stdio (Protocolo de Contexto do Modelo (MCP)) Inicia o DAB como um servidor MCP que usa entrada e saída padrão (STDIO) em vez de HTTP. Requer mcp.enabled: true na configuração.
--no-https-redirect Desabilita o redirecionamento automático HTTP→HTTPS
--verbose Define o nível de registo para Informativo
--help Mostra o ecrã de ajuda.
--version Mostrar a informação da versão.

-c, --config

Caminho para o arquivo de configuração. Por defeito, dab-config.json a menos que dab-config.<DAB_ENVIRONMENT>.json exista, onde DAB_ENVIRONMENT é uma variável de ambiente.

Example

dab start \
  --config ./settings/dab-config.json

--LogLevel <level>

Especifica o nível de registo como valor fornecido. Para valores possíveis, veja Níveis logarítmicos.

Example

dab start \
  --LogLevel Warning

--no-https-redirect

Desabilita o redirecionamento automático HTTP→HTTPS.

Example

dab start \
  --no-https-redirect

--mcp-stdio

Observação

Esta opção é uma funcionalidade do Protocolo de Contexto de Modelo (MCP) disponível na versão e 1.7 posteriormente. Requer "mcp": { "enabled": true } na runtime secção do seu dab-config.jsonarquivo . Para detalhes completos da configuração do MCP, consulte a visão geral do SQL MCP Server.

Inicia o Data API Builder como um servidor MCP que usa entrada e saída padrão em vez de se ligar a uma porta HTTP. Neste modo, o DAB comunica com um cliente MCP (como GitHub Copilot, Visual Studio (VS) Code ou qualquer agente de IA compatível com MCP) inteiramente através stdin e stdout utilizando o Protocolo de Contexto do Modelo. Nenhum servidor HTTP ou porta de rede está exposta.

Este flag também aceita um argumento role:<role-name> posicional opcional que especifica o papel de permissão DAB sob o qual todas as chamadas de ferramenta MCP são executadas. O papel deve corresponder a um nome definido na permissions secção da configuração da sua entidade. Se for omitido, a função é definida por defeito como anonymous.

Quando --mcp-stdio está ativa, os seguintes comportamentos são aplicados automaticamente independentemente das definições do ficheiro de configuração:

  • Codificação: A entrada/saída da consola é forçada a UTF-8 sem marca de ordem de bytes (BOM) para comunicação limpa JSON sobre entrada/saída padrão.
  • Autenticação: O fornecedor de autenticação é forçado a entrar em modo Simulador , permitindo o papel especificado sem exigir um verdadeiro JSON Web Token (JWT) ou fornecedor de identidade.
  • Sem host HTTP: O DAB não se liga a nenhuma porta do Protocolo de Controlo de Transmissão (TCP). O servidor MCP corre inteiramente sobre stdin/stdout.

Importante

O role:<name> prefixo é obrigatório. Se o nome da função não corresponder a uma função definida nas permissões da sua entidade, as chamadas à ferramenta MCP são negadas.

Configuração necessária

O MCP deve estar ativado em your dab-config.json antes de usar --mcp-stdio:

"runtime": {
  "mcp": {
    "enabled": true,
    "path": "/mcp",
    "dml-tools": {
      "create-record": true,
      "read-records": true,
      "update-record": true,
      "delete-record": true
    }
  }
}

Example

# Default anonymous role
dab start \
  --mcp-stdio \
  --config ./dab-config.json

# Specific role
dab start \
  --mcp-stdio role:authenticated \
  --config ./dab-config.json

# With logging
dab start \
  --mcp-stdio role:api-reader \
  --config ./dab-config.json \
  --LogLevel Information

Configuração do cliente MCP

Como o DAB corre como um subprocesso que comunica sobre entrada e saída padrão, o seu cliente MCP deve lançar o DAB como um processo filho e pipe stdin e stdout. Uma configuração típica de cliente MCP para Visual Studio (VS) Code ou um agente compatível é a seguinte:

{
  "servers": {
    "my-database": {
      "type": "stdio",
      "command": "dab",
      "args": [
        "start",
        "--mcp-stdio",
        "role:anonymous",
        "--config",
        "./dab-config.json"
      ]
    }
  }
}

Para um guia completo, consulte o transporte padrão de entrada e saída para SQL MCP Server.

--verbose

Define o nível de registo para Informacional. Isto é um flag de conveniência equivalente a --LogLevel Information.

Example

dab start \
  --verbose

--help

Mostra o ecrã de ajuda.

Example

dab start --help

--version

Mostrar a informação da versão.

Example

dab start --version
  • Last updated on