Compartilhar via


start comando

Inicie o runtime do Construtor de API de Dados com um arquivo de configuração existente.

Sintaxe

dab start [options]

Olhar rápido

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

Seção Cabeçalho

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

-c, --config

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

Example

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

--LogLevel <level>

Especifica o nível de log conforme o valor fornecido. Para obter valores possíveis, consulte os níveis de log.

Example

dab start \
  --LogLevel Warning

--no-https-redirect

Desabilita o redirecionamento HTTP→HTTPS automático.

Example

dab start \
  --no-https-redirect

--mcp-stdio

Observação

Essa opção é um recurso MCP (Model Context Protocol) disponível na versão 1.7 e posterior. Ele requer "mcp": { "enabled": true } na runtime seção do seu dab-config.json. Para obter detalhes completos da configuração do MCP, consulte a visão geral do SQL MCP Server.

Inicia o construtor de API de Dados como um servidor MCP que usa entrada e saída padrão em vez de associar a uma porta HTTP. Nesse modo, o DAB se comunica com um cliente MCP (como o GitHub Copilot, o Visual Studio (VS) Code ou qualquer agente de IA compatível com MCP) completamente por completo stdinstdout e usando o Protocolo de Contexto de Modelo. Nenhum servidor HTTP ou porta de rede é exposto.

Esse sinalizador também aceita um argumento posicional role:<role-name> opcional que especifica a função de permissão DAB sob a qual todas as chamadas de ferramenta MCP são executadas. A função deve corresponder a um nome definido na permissions seção da configuração da entidade. Se omitida, a função usará como padrão anonymous.

Quando --mcp-stdio estiver ativo, os seguintes comportamentos serão aplicados automaticamente, independentemente das configurações do arquivo de configuração:

  • Codificação: a entrada/saída do console é forçada a UTF-8 sem uma marca de ordem de byte (BOM) para comunicação de entrada/saída JSON-over-standard limpa.
  • Autenticação: o provedor de autenticação é forçado ao modo Simulador , habilitando a função especificada sem exigir um JWT (Token Web JSON) real ou um provedor de identidade.
  • Nenhum host HTTP: o DAB não se associa a nenhuma porta TCP (Protocolo de Controle de Transmissão). O servidor MCP é executado inteiramente por stdin/stdout.

Importante

O role:<name> prefixo é necessário. Se o nome da função não corresponder a uma função definida em suas permissões de entidade, as chamadas à ferramenta MCP serão negadas.

Configuração necessária

O MCP deve estar habilitado no seu 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 é executado como um subprocesso que se comunica por entrada e saída padrão, seu cliente MCP deve iniciar o DAB como um processo filho e pipe stdin e stdout. Uma configuração típica do cliente MCP para Visual Studio (VS) Code ou um agente compatível tem a seguinte aparência:

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

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

--verbose

Define o nível de log como Informativo. Este é um sinalizador de conveniência equivalente a --LogLevel Information.

Example

dab start \
  --verbose

--help

Exiba a tela de ajuda.

Example

dab start --help

--version

Exibir informações de versão.

Example

dab start --version