Configuração do servidor MongoDB MCP

Compatibilidade com IA do cliente

O servidor MCP é compatível com muitos clientes de IA que oferecem suporte ao MCP. Por exemplo, você pode usar esses clientes de IA:

• Vinda

• VS Code

• lau Desktop

• Cursor

A estrutura do arquivo de configuração JSON pode variar para cada cliente de IA. Leia a documentação do cliente de IA para obter detalhes.

Pré-requisitos

Certifique-se de já ter instalado o software conforme especificado nos pré-requisitos do software do servidor MCP.

O Servidor MCP pode executar ferramentas do Atlas que executam várias operações do Atlas . Para executar as ferramentas do Atlas , seu cluster do Atlas exige uma conta de serviço com as permissões apropriadas.

Para configurar uma conta de serviço, consulte Pré-requisitos do servidor MongoDB MCP para executar o Atlas FERRAMENTAS.

Para obter uma lista dos FERRAMENTAS, consulte FERRAMENTAS do servidor do MongoDB MCP.

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

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

A tabela a seguir mostra as principais opções de configuração do Servidor MCP.

Métodos de configuração do servidor MCP

Para configurar o servidor MCP, use qualquer um destes métodos:

• Arquivo de configuração JSON com opções do servidor MCP

• Opções de linha de comando

• Variáveis de ambiente do sistema operacional

O servidor MCP usa credenciais do Atlas API ou uma string de conexão para acessar um cluster.

...
"args": [
   "-y",
   "mongodb-mcp-server",
   "--apiClientId", "<atlas-service-accounts-client-id>",
   "--apiClientSecret", "<atlas-service-accounts-client-secret>",
   "--readOnly"
]
...

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

...
"args": [
   "-y",
   "mongodb-mcp-server",
   "--connectionString",
   "mongodb://127.0.0.1:27019/?directConnection=true",
   "--readOnly"
]
...

# Set Atlas API credentials for a service account
export MDB_MCP_API_CLIENT_ID="<atlas-service-accounts-client-id>"
export MDB_MCP_API_CLIENT_SECRET="<atlas-service-accounts-client-secret>"
# Set a MongoDB connection string
export MDB_MCP_CONNECTION_STRING="mongodb+srv://testUsername:testPassword@testCluster.mongodb.net/testDatabase"
# Change the MCP Server log path from the default
export MDB_MCP_LOG_PATH="/mcp/logs"

:: Set Atlas API credentials for a service account
set MDB_MCP_API_CLIENT_ID=<atlas-service-accounts-client-id>
set MDB_MCP_API_CLIENT_SECRET=<atlas-service-accounts-client-secret>
:: Set a MongoDB connection string
set MDB_MCP_CONNECTION_STRING="mongodb+srv://testUsername::testPassword@testCluster.mongodb.net/testDatabase"
:: Change the MCP Server log path from the default
set MDB_MCP_LOG_PATH="C:\mcp\logs"

# Set Atlas API credentials for a service account
$env:MDB_MCP_API_CLIENT_ID="<atlas-service-accounts-client-id>"
$env:MDB_MCP_API_CLIENT_SECRET="<atlas-service-accounts-client-secret>"
# Set a MongoDB connection string
$env:MDB_MCP_CONNECTION_STRING="mongodb+srv://testUsername::testPassword@testCluster.mongodb.net/testDatabase"
# Change the MCP Server log path from the default
$env:MDB_MCP_LOG_PATH="C:\mcp\logs"

...
"args": ["-y", "mongodb-mcp-server"],
"env": {
   "MDB_MCP_CONNECTION_STRING":
   "mongodb+srv://<user-name>:<password>@<cluster-name>.mongodb.net/testDatabase"
}
...

...
"args": ["-y", "mongodb-mcp-server"],
"env": {
   "MDB_MCP_API_CLIENT_ID": "<atlas-service-accounts-client-id>",
   "MDB_MCP_API_CLIENT_SECRET": "<atlas-service-accounts-client-secret>"
}
...

Habilitando o modo somente leitura do servidor MCP

Você pode limitar o servidor MCP para executar somente operações de leitura utilizando o modo read-only.

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

Para ativar o modo somente leitura com uma opção de linha de comando, use:

--readOnly

Para habilitar o modo somente leitura usando uma variável de ambiente, defina a variável de ambiente MDB_MCP_READ_ONLY como true:

export MDB_MCP_READ_ONLY=true

Ao ativar o modo somente leitura, uma mensagem é adicionada ao registro do servidor MCP que indica que os FERRAMENTAS que executam operações de gravação são impedidos de serem executados.

Solução de problemas do servidor MCP

Se você tiver problemas com o servidor MCP, examine os registros do servidor MCP para obter informações que possam ajudar a solucionar o problema.

Por padrão, o servidor MCP grava os logs no disco e também envia os logs para o cliente MCP. Você pode alterar a opção loggers para especificar para onde os registros são enviados. Para obter detalhes sobre as opções do servidor MCP, consulte Opções de configuração do servidor MCP.

A tabela a seguir mostra os diretórios padrão onde o servidor MCP armazena os arquivos de log:

Você pode alterar o caminho do registro, se necessário. Para fazer isso, defina um destes:

• logPath opção em um arquivo de configuração JSON ou linha de comando

• MDB_MCP_LOG_PATH Variável de ambiente

Desativando ferramentas de servidor MCP

Para restringir o acesso ao Atlas e operações de banco de dados , você pode desabilitar ferramentas específicas do Servidor MCP ou categorias de ferramentas.

Para desativar o FERRAMENTAS, defina a opção de configuração disabledTools MCP Server, que é uma array de strings. Cada string pode ser um nome de ferramenta ou categoria de ferramenta.

A tabela a seguir mostra os nomes das ferramentas que você pode desabilitar:

A tabela a seguir mostra as categorias de ferramentas que você pode desativar:

Para desabilitar o FERRAMENTAS com a opção de linha de comando disabledTools, use uma lista separada por espaço. Por exemplo:

--disabledTools create update delete atlas

Para desabilitar o FERRAMENTAS com a variável de ambiente MDB_MCP_DISABLED_TOOLS, use uma string separada por vírgula. Por exemplo:

export MDB_MCP_DISABLED_TOOLS="create,update,delete,atlas"

Desativando a telemetria do servidor MCP

Para impedir que o servidor MCP coleta dados sobre o uso, você pode desativar a telemetria.

Para desativar a telemetria usando uma variável de ambiente, defina uma destas:

export MDB_MCP_TELEMETRY=disabled
export DO_NOT_TRACK=1

Para desativar a telemetria usando uma opção de linha de comando, use:

--telemetry disabled

Habilitando verificação de índice

Para garantir que as operações de consulta usem um índice, habilite a opção de verificação de índice. Quando ativado, o servidor MCP rejeita as queries que realizam uma verificação de collection para melhorar o desempenho e garantir que as queries sejam otimizadas.

Para habilitar a verificação do índice com uma opção de linha de comando, use:

--indexCheck

Para ativar a verificação do índice com uma variável de ambiente, use:

export MDB_MCP_INDEX_CHECK=true

Se você habilitar a verificação de índice, o servidor MCP registrará uma mensagem de erro se uma query for rejeitada porque não usa um índice.

Iniciando o servidor MCP como serviço independente usando o comando npx

Para iniciar o Servidor MCP como um serviço autônomo , use o comando npx.

npx -y mongodb-mcp-server@latest \
   --apiClientId="<atlas-service-accounts-client-id>" \
   --apiClientSecret="<atlas-service-accounts-client-secret>" \
   --connectionString="mongodb+srv://<user-name>:<password>@<cluster-name>.mongodb.net/<database-name>" \
   --logPath=</path/to/logs> --readOnly --indexCheck --loggers mcp stderr

npx -y mongodb-mcp-server@latest --readOnly

npx -y mongodb-mcp-server@latest --transport http --readOnly

npx -y mongodb-mcp-server@latest \
   --transport http --httpHost=324.1.5.7 --httpPort=8080 --readOnly

Saiba mais

• MongoDB MCP Server FERRAMENTAS

• Exemplos de uso do servidor MongoDB MCP