Menu Docs
Página inicial do Docs
/ /
Configurar
Página inicial do Docs
/
Ferramentas
/
Servidor MCP do MongoDB
/
Configurar
Página inicial do Docs
/
Ferramentas
/
Servidor MCP do MongoDB
/
Configurar

Opções de configuração do servidor MongoDB MCP

O Servidor MCP tem várias opções que você pode definir para se conectar a um cluster MongoDB e controlar as operações do Servidor MCP. Você pode definir as opções em um arquivo de configuração JSON, por meio de uma linha de comando ou usando variáveis de ambiente do sistema operacional.

Lista de opções

Use as seguintes opções de configuração para configurar o Servidor MCP.

Importante

Se você for um usuário do MongoDB Enterprise ou do MongoDB Atlas e precisar de um mecanismo de autenticação específico, consulte a seção Segurança do Servidor MongoDB MCP para saber mais sobre as opções de configuração do seu método de autenticação.

Nome da opção CLI
Nome da variável de ambiente do sistema operacional
Tipo
Default
Descrição

allowRequestOverrides

MDB_MCP_ALLOW_REQUEST_OVERRIDES

booleano

false

Sinalizador que indica se os usuários podem substituir as configurações do Servidor MCP por solicitação por cabeçalhos de solicitação e parâmetros de consulta. Para o comportamento de substituição específico de cada opção de configuração, consulte a Tabela de Comportamento de Substituição abaixo.

apiClientId

MDB_MCP_API_CLIENT_ID

string

Não definido

ID do cliente Atlas API para autenticação.

apiClientSecret

MDB_MCP_API_CLIENT_SECRET

string

Não definido

Segredo do cliente Atlas API para autenticação.

config

MDB_MCP_CONFIG

string

Não definido

Caminho completo para o arquivo de configuração JSON. O uso da variável de ambiente MDB_MCP_CONFIG é recomendado em vez do uso da opção de linha de comando --config.

connectionString

MDB_MCP_CONNECTION_STRING

string

Não definido

Connection string para uma conexão direta do banco de dados .

Define a string de conexão no tempo de execução para permitir que o cliente se conecte diretamente a um cluster.

Importante

O argumento CLI --connectionString está obsoleto. Em vez dela, use a variável de ambiente MDB_MCP_CONNECTION_STRING. Se as variáveis de ambiente não forem uma opção, use o primeiro argumento posicional.

Observação

Normalmente, evite fornecer a string de conexão no tempo de execução porque você expõe as credenciais de conexão ao grandes modelos de linguagem.

A string de conexão é usada se o cliente nunca tiver se conectado antes ou se o cliente alternar a conexão para um novo cluster se o cliente tiver sido conectado anteriormente.

Depois que o cliente chama a ferramenta de conexão ou de alternância de conexão, o cliente reutiliza a mesma conexão para operações subsequentes. Portanto, você só precisa chamar a ferramenta de conexão ou alternar uma vez ou se precisar alternar para uma conexão diferente.

dryRun

MDB_MCP_DRY_RUN

booleano

false

Use a opção de execução seca para examinar a configuração do servidor MCP. Quando você ativa a opção de execução seca, o servidor MCP retorna as definições de configuração do servidor MCP e a lista de FERRAMENTAS ativadas do servidor MCP do MongoDB MongoDB MCP Server Tools.

Para habilitar a opção de executar dry-run, defina --dryRun no arquivo de configuração ou na linha de comando, ou defina a variável de ambiente do sistema operacional MDB_MCP_DRY_RUN como true.

Para obter mais informações, consulte Ativação do modo de execução seca do servidor MCP.

loggers

MDB_MCP_LOGGERS

string

disk mcp

Caminho para onde o Servidor MCP envia os logs.

Defina loggers para uma ou mais das seguintes opções:

  • disk, que grava registros em arquivos de disco localizados no caminho especificado na opção logPath.

  • mcp, que envia os registros para o cliente de IA, se o cliente suportar protocolo de registro e transporte.

  • stderr, que envia os registros para a saída de erro padrão. Esta configuração é útil para depuração ou ao executar MCP em um contêiner.

Por exemplo, para definir loggers como mcp e stderr no arquivo de configuração JSON do cliente IA ou na linha de comando do sistema operacional, use --loggers mcp stderr.

Para definir a variável de ambiente do sistema operacional MDB_MCP_LOGGERS como disk e stderr, use export MDB_MCP_LOGGERS="disk,stderr".

Para obter mais informações sobre as opções de registro, consulte Solucionar problemas do servidor MongoDB MCP.

logPath

MDB_MCP_LOG_PATH

string

Depende do sistema operacional

Diretório que armazena os registros do servidor MCP.

Observação

Bloqueie o diretório para que o usuário que executa o servidor MCP seja o proprietário com permissão de leitura/gravação. Isso impede que qualquer outro processo acesse os diretórios ou arquivos do servidor .

Para obter mais informações sobre o caminho do registro e especificações do sistema operacional, consulte Solucionar problemas do servidor MongoDB MCP.

disabledTools

MDB_MCP_DISABLED_TOOLS

array

Não definido

Array de nomes de ferramentas MCP, tipos de operação ou categorias de ferramentas para desabilitar.

Para obter mais informações, consulte Desativando o Servidor MCP FERRAMENTAS.

readOnly

MDB_MCP_READ_ONLY

booleano

false

Sinalizador que determina se as operações de gravação são permitidas. Para desabilitar operações de gravação de cluster, defina --readOnly no arquivo de configuração ou linha de comando ou defina a variável de ambiente do sistema operacional MDB_MCP_READ_ONLY como true.

O padrão é permitir operações de gravação do cluster. Normalmente, sempre ative o modo somente leitura .

Para obter mais informações, consulte Habilitar o modo somente leitura do servidor MCP.

indexCheck

MDB_MCP_INDEX_CHECK

booleano

false

Sinalizador que indica se os índices são necessários para as queries. Se true, força que as operações de query devem usar um índice e rejeita queries que executam varreduras de coleção.

Para obter mais informações, consulte Habilitando a verificação de índice.

telemetry

MDB_MCP_TELEMETRY

string

enabled

Sinalizador que indica se os dados de uso são coletados pelo Servidor MCP. Se disabled, a coleção de dados de uso do servidor MCP será interrompida.

Para obter mais informações, consulte Desabilitar a telemetria do servidor MCP.

transport

MDB_MCP_TRANSPORT

string

stdio

Protocolo de transporte para comunicações com o servidor MCP.

Defina transport para uma das seguintes opções:

  • stdio, que é o padrão. Utiliza a entrada e saída padrão para comunicações com o Servidor MCP. stdio é adequado para a maioria dos clientes de IA.

  • http, que permite comunicações HTTP com o Servidor MCP. Em seguida, você pode usar HTTP para interagir com o Servidor MCP a partir de um cliente Web ou se comunicar com o Servidor MCP em uma porta IP HTTP específica.

    Aviso

    O transporte HTTP NÃO é recomendado para uso de produção sem implementar medidas adequadas de autenticação e segurança.

httpPort

MDB_MCP_HTTP_PORT

inteiro

3000

Número da porta IP para comunicações HTTP com o servidor MCP.

httpHost

MDB_MCP_HTTP_HOST

string

127.0.0.1

Endereço IP para comunicações HTTP com o servidor MCP.

Com o Streamable HTTP, o servidor MCP é vinculado a localhost (127.0.0.1) por padrão. Isso garante que o servidor MCP aceite somente conexões originadas no mesmo computador.

Aviso

A vinculação ao 0.0.0.0 expõe o servidor MCP a toda a rede local, o que permite que outros dispositivos na mesma rede acessem potencialmente o servidor MCP. Isso é um risco à segurança e pode permitir o acesso não autorizado ao contexto do seu banco de dados . Se você precisar expor o servidor MCP fora de localhost, implemente uma autenticação de segurança forte.

Para saber mais, consulte Conexões remotas.

httpBodyLimit

MDB_MCP_HTTP_BODY_LIMIT

inteiro

102400

Tamanho máximo do corpo da solicitação HTTP em bytes. Aplica-se apenas ao transporte HTTP.

healthCheckHost

MDB_MCP_HEALTH_CHECK_HOST

string

Não definido

Endereço de host para o servidor HTTP healthCheck separado. Este é um ponto de conexão HTTP que o Kubernetes e o Docker podem usar para verificar a integridade do processo MCP. Aplica-se apenas ao transporte HTTP.

Se fornecido, a configuração healthCheckPort é necessária.

healthCheckPort

MDB_MCP_HEALTH_CHECK_PORT

inteiro

Não definido

Número da porta do servidor HTTP HealthCheck separado. Este é um ponto de conexão HTTP que o Kubernetes e o Docker podem usar para verificar a integridade do processo MCP. Aplica-se apenas ao transporte HTTP.

Se fornecido, a configuração healthCheckHost é necessária.

idleTimeoutMs

MDB_MCP_IDLE_TIMEOUT_MS

inteiro

600000

Tempo limite ocioso para um cliente se desconectar. Aplica-se apenas ao transporte HTTP.

notificationTimeoutMs

MDB_MCP_NOTIFICATION_TIMEOUT_MS

inteiro

540000

Tempo limite de notificação para que um cliente esteja ciente da desconexão. Aplica-se apenas ao transporte HTTP.

authenticationMechanism

MDB_MCP_AUTHENTICATION_MECHANISM

string

SCRAM-SHA-256

Mecanismo de autenticação a ser usado ao se conectar às suas implantações MongoDB com o servidor MongoDB MCP.

SCRAM é o mecanismo de autenticação padrão para MongoDB. Para se conectar usando outros métodos de autenticação, consulte as seguintes páginas:

exportsPath

MDB_MCP_EXPORTS_PATH

string

Depende do sistema operacional

Diretório que armazena arquivos de dados exportados.

Observação

Bloqueie o diretório para que o usuário que executa o servidor MCP seja o proprietário com permissão de leitura/gravação. Isso impede que qualquer outro processo acesse os diretórios ou arquivos exportados.

Para obter mais informações sobre o caminho de exportação e especificações do sistema operacional, consulte Exportar dados do servidor MongoDB MCP.

exportTimeoutMs

MDB_MCP_EXPORT_TIMEOUT_MS

inteiro

300000

Tempo em milissegundos após o qual os arquivos de dados exportados estão qualificados para exclusão pelo processo de limpeza do Servidor MCP.

exportCleanupIntervalMs

MDB_MCP_EXPORT_CLEANUP_INTERVAL_MS

inteiro

120000

Período de tempo em milissegundos entre execuções automáticas do processo de limpeza do Servidor MCP que exclui arquivos de dados de exportação expirados. O processo de limpeza é executado automaticamente.

previewFeatures

MDB_MCP_PREVIEW_FEATURES

string

Não definido

Valores separados por vírgula de recursos de visualização que estão habilitados. Valores válidos: search.

Opções de Vector Search

Importante

O suporte à pesquisa vetorial no MCP está disponível como um recurso de visualização. Para habilitar esse recurso, defina o sinalizador previewFeatures ou a variável de ambiente MDB_MCP_PREVIEW_FEATURES como search em sua configuração de MCP.

As opções a seguir configuram o comportamento do servidor MCP quando você o usa para trabalhar com pesquisa vetorial do MongoDB.

Nome da opção CLI
Nome da variável de ambiente do sistema operacional
Tipo
Default
Descrição

voyageApiKey

MDB_MCP_VOYAGE_API_KEY

string

Não definido

Chave de API Voyage IA para geração automática de incorporação.

Quando você configura esta opção, o Servidor MCP gera automaticamente incorporações para:

  • Documentos que você insere com a ferramenta insert-many

  • O parâmetro queryVector em $vectorSearch queries de agregação

O Servidor MCP também valida que os campos com índices de pesquisa vetorial contêm vetores de incorporação válidos para evitar a quebra de índices de pesquisa vetorial.

O servidor MongoDB MCP suporta os seguintes modelos de Voyage IA:

  • voyage-3-large

  • voyage-3.5

  • voyage-3.5-lite

  • voyage-code-3

Para aprender mais sobre a IA do Voyage, consulte a documentação da IA do Voyage.

Para opções adicionais de configuração da pesquisa vetorial, consulte Opções de pesquisa vetorial.

embeddingsValidation

MDB_MCP_EMBEDDINGS_VALIDATION

booleano

true

Sinalizador que indica se os vetores de incorporação são validados. Quando definido como true, habilita a validação de dimensões incorporadas.

Por padrão, o servidor MCP valida que os campos com índices de pesquisa vetorial contêm vetores de incorporação válidos com as dimensões corretas para evitar a quebra de índices de pesquisa vetorial. Desative esta opção para permitir a inserção de valores brutos em campos de incorporação sem validação.

Aviso

A desativação da validação de incorporações pode resultar em documentos com incorporações inválidas que não podem ser usadas com índices de pesquisa vetorial.

vectorSearchDimensions

MDB_MCP_VECTOR_SEARCH_DIMENSIONS

inteiro

1024

Número padrão de dimensões para embeddings de pesquisa vetorial.

Este valor é utilizado ao criar índices de pesquisa vetorial e validar incorporações.

vectorSearchSimilarityFunction

MDB_MCP_VECTOR_SEARCH_SIMILARITY_FUNCTION

string

euclidean

Função de similaridade padrão para pesquisa vetorial. Defina para um dos seguintes valores:

  • euclidean: Distância euclideana

  • cosine: similaridade do cosseno

  • dotProduct: similaridade do produto pontual

O servidor MCP utiliza este valor como padrão ao criar índices de pesquisa vetorial, a menos que especificado de outra forma. Para saber mais, consulte Como indexar campos para pesquisa vetorial.

Comportamentos de substituição de opções de configuração

A tabela a seguir descreve o comportamento de substituição de cada opção de configuração. Estes comportamentos de substituição se aplicam somente se a opção de configuração do allowRequestOverrides estiver definida como true. Se um usuário tentar substituir uma opção de configuração que proíbe substituições, o servidor MCP recusará a conexão.

Config Key
Substituir comportamento
Condição adicional

apiBaseUrl

Proibido

apiClientId

Proibido

apiClientSecret

Proibido

allowRequestOverrides

Proibido

connectionString

Proibido

config

Proibido

loggers

Proibido

logPath

Proibido

disabledTools

Merge

Desabilita ferramentas além daquelas na configuração existente.

confirmationRequiredTools

Merge

Requer confirmação para ferramentas além daquelas na configuração existente.

readOnly

Condicional

Só pode substituir uma configuração false existente por true.

indexCheck

Condicional

Só pode substituir uma configuração false existente por true.

telemetry

Proibido

transport

Proibido

httpPort

Proibido

httpHost

Proibido

httpHeaders

Proibido

healthCheckHost

Proibido

healthCheckPort

Proibido

idleTimeoutMs

Condicional

Só pode ser substituído por um tempo limite menor do que a configuração existente.

notificationTimeoutMs

Condicional

Só pode ser substituído por um tempo limite menor do que a configuração existente.

maxBytesPerQuery

Proibido

maxDocumentsPerQuery

Proibido

exportsPath

Proibido

exportTimeoutMs

Condicional

Só pode ser substituído por um tempo limite menor do que a configuração existente.

exportCleanupIntervalMs

Proibido

atlasTemporaryDatabaseUserLifetimeMs

Condicional

Só pode ser substituído por uma vida útil menor do que a configuração existente.

voyageApiKey

Proibido

embeddingsValidation

Condicional

Só pode substituir uma configuração false existente por true.

vectorSearchDimensions

Sobrepor

vectorSearchSimilarityFunction

Sobrepor

previewFeatures

Condicional

Só pode desabilitar recursos na configuração existente, não adicionar recursos adicionais.

Argumentos Posicionais

O servidor MCP aceita um argumento posicional que pode ser fornecido sem especificar um sinalizador CLI. O primeiro argumento posicional é interpretado como a string de conexão para sua implantação do MongoDB .

Como prática de segurança recomendada, use a variável de ambiente MDB_MCP_CONNECTION_STRING para definir a string de conexão. Se as variáveis de ambiente não forem uma opção, use o primeiro argumento posicional. Por exemplo:

"args": [
   "-y",
   "mongodb-mcp-server",
   "mongodb+srv://<user-name>:<password>@<cluster-name>.mongodb.net/",
   "--readOnly"
]

Saiba mais

Voltar

Configurar

Próximo

Métodos

Nesta página