Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs

MongoDB MCP Server FERRAMENTAS

O servidor MongoDB MCP permite a interação com clusters MongoDB usando queries de linguagem natural de clientes de IA com suporte a MCP. Esta página descreve as ferramentas do servidor MCP.

O servidor MongoDB MCP fornece as seguintes categorias de ferramentas:

  • Ferramentas do Atlas, que executam operações nos recursos do sistema do Atlas, como organizações, projetos, clusters, contas de usuário de banco de dados e recuperação de recomendações de desempenho.

  • Ferramentas de implantação local do Atlas, que permitem listar, conectar, criar e excluir implantações locais do Atlas.

  • Ferramentas do assistente, que pesquisam a Base de Conhecimento do MongoDB Assistant para obter documentação oficial e orientação selecionada.

  • FERRAMENTAS de banco de dados, que executam operações como inserção, atualização e exclusão de documentos, e execução de queries e pipelines de agregação.

Nem todas as ferramentas do Atlas e ferramentas de banco de dados estão disponíveis no servidor MCP gerenciado do MongoDB Atlas e no MCP local para o servidor MCP do MongoDB. As colunas Atlas gerenciado e local em cada uma dessas tabelas indicam se um tipo de implantação MCP oferece suporte a uma determinada ferramenta.

As FERRAMENTAS do Atlas só estarão disponíveis se você tiver configurado as credenciais da API do Atlas, conforme descrito em Configuração do servidor MCP do MongoDB.

A tabela seguinte descreve o Atlas FERRAMENTAS. As colunas Atlas Managed e Local indicam se cada FERRAMENTAS está disponível no MongoDB Atlas Managed MCP Server e no Local MCP for MongoDB MCP Server, respectivamente.

Nome da ferramenta Atlas
Descrição
Atlas gerenciado
Local

atlas-list-orgs

Retorna uma lista de organizações do Atlas .

atlas-list-projects

Retorna uma lista de projetos do Atlas .

atlas-create-project

Cria um novo projeto Atlas .

atlas-list-clusters

Retorna a lista de Atlas clusters.

atlas-inspect-cluster

Retorna informações sobre um Atlas cluster específico.

atlas-create-free-cluster

Cria um Atlas cluster gratuito.

atlas-connect-cluster

Conecta-se a um cluster Atlas usando a conta de serviço configurada.

Se você configurou o servidor MCP sem especificar uma string de conexão, esta ferramenta criará um usuário de banco de dados temporário com uma senha aleatória para estabelecer a conexão. Para obter detalhes, consulte Detalhes da ferramenta.

atlas-get-regions

Retorna as regiões do Atlas compatíveis com um provedor de nuvem (AWS, AZURE ou GCP), incluindo o código de cada região e a localização legível por humanos. Use essa ferramenta para resolver nomes ou códigos de região antes de criar ou atualizar um cluster.

atlas-upgrade-cluster

Suporta as seguintes atualizações de cluster do Atlas :

  • Grátis para flexibilidade

  • Grátis para M10

  • Flex para M10

Opcionalmente, você pode especificar o destino region e provider.

Para um cluster dedicado, você pode dimensionar o cluster para um tamanho de instância M10 a M80 diferente e atualizar suas configurações de dimensionamento automático de computação. Especifique pelo menos uma das seguintes opções:

  • O novo tamanho de instância

  • Se o dimensionamento automático de computação deve ser ativado

  • O tamanho mínimo ou máximo da instância para dimensionamento automático

O dimensionamento se aplica a nós elegíveis e read-only. Esta ferramenta não escala nós de analítica, clusters de vários fragmentos ou clusters cujas regiões usam tamanhos de instância diferentes.

atlas-create-cluster

Cria um cluster Atlas dedicado com tamanhos de instância M10–M80. Suporta tipos de cluster de conjunto de réplicas e de shard único em uma a três regiões.

  • clusterType O padrão é REPLICASET. Os clusters SHARDED são apenas de shard único e exigem M30 ou superior.

  • regions aceita até três regiões Atlas em ordem de prioridade. A primeira região tem a maior prioridade e mantém o nó primário.

  • encryptionAtRestProvider seleciona um provedor de chaves gerenciado pelo cliente para criptografia em descanso. O provedor de chaves já deve ter uma configuração válida de criptografia em descanso no projeto.

  • O dimensionamento automático de computação está habilitado por padrão. O dimensionamento automático de disco está sempre habilitado.

  • A ferramenta retorna imediatamente. Use atlas-inspect-cluster para pesquisar até que o estado do cluster atinja IDLE.

atlas-pause-resume-cluster

Pausa ou retoma um cluster Atlas dedicado (M10+). Os clusters Free e Flex não podem ser pausados.

  • Pausar: Torna o cluster indisponível para conexões e interrompe os custos de computação. O cluster deve estar no estado IDLE.

  • Retomar: reinicia um cluster pausado. Use atlas-inspect-cluster para pesquisar até que o estado do cluster atinja IDLE.

atlas-inspect-access-list

Retorna informações sobre os intervalos IP e CIDR que podem acessar um cluster do Atlas.

atlas-create-access-list

Configura a lista de acesso IP e CIDR para um cluster Atlas.

atlas-list-db-users

Retorna uma lista de usuários do banco de dados do Atlas .

atlas-create-db-user

Cria um usuário de banco de dados Atlas .

atlas-list-alerts

Retorna uma lista de alertas para um projeto Atlas .

atlas-get-performance-advisor

atlas-load-sample-dataset

Carrega um conjunto de dados de amostra em um cluster do Atlas.

remote-atlas-connect

Conecta-se a um cluster Atlas no servidor MCP remoto.

atlas-streams-discover

Retorna informações sobre um espaço de trabalho, processador, conexão pública ou conexão de rede privatelink do Atlas Stream Processing .

No servidor MCP remoto, as ferramentas do Atlas Stream Processing são expostas por meio das ferramentas atlas-streams-*.

atlas-streams-build

Cria um espaço de trabalho, processador, conexão pública ou conexão de rede privatelink do Atlas Stream Processing .

atlas-streams-manage

Gerencia um espaço de trabalho, processador ou conexão pública do Atlas Stream Processing . O servidor MongoDB MCP pode:

  • Inicie, pare ou atualize um processador.

  • Atualize um espaço de trabalho.

  • Atualize uma conexão pública.

  • Aceitar ou rejeitar uma conexão de rede do privatelink.

atlas-streams-teardown

Exclui um espaço de trabalho, processador, conexão pública ou conexão de rede privatelink do Atlas Stream Processing .

Você pode utilizar o servidor MCP com implantações locais do Atlas. Para usar as FERRAMENTAS do servidor MCP com implantações locais do Atlas, você deve instalar o Docker. Para uma introdução às implantações locais do Atlas, consulte Criar uma implantação local do Atlas.

A tabela seguinte descreve as ferramentas Atlas locais:

Nome da ferramenta Atlas local do servidor MCP
Descrição

atlas-local-list-deployments

Lista implantações locais do Atlas.

atlas-local-create-deployment

Cria uma implantação local do Atlas. Para executar esta ferramenta, você deve desativar o modo somente leitura.

atlas-local-connect-deployment

Conecta a uma implantação local do Atlas.

atlas-local-delete-deployment

Exclui uma implantação local do Atlas. Para executar esta ferramenta, você deve desativar o modo somente leitura.

Para exemplos que executam as FERRAMENTAS locais do Atlas, consulte Implantações locais do Atlas.

A tabela a seguir descreve as ferramentas do banco de dados . As colunas Atlas Managed e Local indicam se cada ferramenta está disponível no MongoDB Atlas Gerenciado MCP servidor e Local MCP para MongoDB MCP servidor, respectivamente.

Nome da Ferramenta de Banco de Dados
Descrição
Atlas gerenciado
Local

connect

Conecta a um cluster MongoDB.

find

Executa uma query de banco de dados MongoDB.

aggregate

Executa um pipeline de agregação MongoDB.

aggregate-db

Executa um pipeline de agregação MongoDB no nível do banco de dados.

count

Retorna o número de documentos em uma coleção.

explain

Retorna estatísticas descrevendo a execução do plano vencedor escolhido pelo otimizador de query para o método avaliado.

insert-many

Adiciona documentos a uma coleção.

create-index

Cria um índice em uma coleção. Esta ferramenta oferece suporte à criação de índices de pesquisa vetorial.

drop-index

Solte um índice para o banco de dados e a coleção fornecidos. Esta ferramenta suporta a eliminação de índices de pesquisa vetorial.

update-one

Modifica um único documento em uma coleção.

update-many

Modifica vários documentos em uma coleção.

rename-collection

Altera o nome de uma coleção.

create-collection

Cria uma nova coleção.

delete-many

Remove documentos de uma collection.

drop-collection

Exclui uma collection de um banco de dados.

drop-database

Exclui um banco de dados.

list-databases

Retorna uma lista de todos os bancos de dados disponíveis através da conexão atual.

list-collections

Retorna uma lista de collections em um banco de dados.

collection-indexes

Retorna informações sobre índices de coleção, incluindo índices de pesquisa vetorial.

collection-schema

Retorna informações do esquema de collection.

collection-storage-size

Retorna o tamanho da coleção em megabytes.

db-stats

Retorna estatísticas do banco de dados .

export

Salva os resultados de uma query ou pipeline de agregação no formato JSON em um arquivo no computador que executa o servidor MCP. Os resultados também estão disponíveis por meio do recurso exported-data no aplicativo cliente de IA.

mongodb-logs

Retorna os eventos mongod registrados mais recentes.

switch-connection

Mude para uma conexão MongoDB diferente.

As ferramentas de assistente dão ao seu cliente de IA acesso à Base de Conhecimento do Assistente MongoDB, que inclui documentação oficial do MongoDB, orientação especializada selecionada e outros recursos fornecidos pelo MongoDB. Essas ferramentas permitem que seu cliente de IA recupere informações precisas e específicas da versão do MongoDB, em vez de depender apenas de seus dados de treinamento.

A tabela a seguir descreve as FERRAMENTAS do assistente:

Nome da ferramenta assistente do servidor MCP
Descrição

list-knowledge-sources

Lista as fontes de dados disponíveis na Base de Conhecimento do MongoDB Assistant. Use-o para explorar as fontes de dados disponíveis ou para encontrar parâmetros de filtro de pesquisa para usar em search-knowledge.

search-knowledge

Pesquisa informações na Base de Conhecimento do MongoDB Assistant. A Base de Conhecimento inclui documentação oficial, orientação especializada selecionada e outros recursos fornecidos pelo MongoDB. Suporta filtro por fonte de dados e versão.

Para obter informações adicionais sobre ferramentas específicas de MCP, consulte as seções a seguir.

O servidor MongoDB MCP oferece suporte à pesquisa vetorial MongoDB. Você pode criar e gerenciar índices de pesquisa vetorial, gerar embeddings e executar query de pesquisa semântica por meio de prompts de linguagem natural. A tabela a seguir resume os principais recursos.

Caso de uso
Exemplo de prompts
Ferramentas relevantes

Gerenciar índices

Create a vector search index on the sample_db database and products collection

Show me all vector search indexes on the products collection

Drop the vector search index named vector_index

create-index
collection-indexes
drop-index

IMPORTANTE: para atualizar um índice de pesquisa vetorial, elimine o índice existente e crie um novo.

Inserir documentos com incorporações automáticas

Insert these documents into the products collection and embed their descriptions

insert-many

Queries de pesquisa vetoriais

Search for documents semantically similar to this description

Find me related products filtered by price range

aggregate

Use os seguintes recursos para aprender mais:

Você pode usar o MongoDB MCP Server para interagir com seus recursos do Atlas Stream Processing. O Atlas Stream Processing permite ler, gravar e transformar fluxos de dados continuamente usando as mesmas operações de agregação usadas pelos bancos de dados do Atlas. Você incorre em cobranças por todos os processadores em execução.

As ferramentas do Atlas Stream Processing (,,atlas-streams-discover atlas-streams-buildatlas-streams-manage atlas-streams-teardowne) estão disponíveis nos servidores de MCP local e gerenciado Atlas . Para obter descrições de ferramentas, consulte a tabela Ferramentas do Atlas Server MCP.

Para mais informações, consulte Atlas Stream Processing.

O servidor MongoDB MCP oferece suporte a dois mecanismos independentes para gerar incorporações vetoriais:

  • Geração de incorporação do servidor MCP: o servidor MCP gera incorporações no lado do cliente usando o Voyage IA antes de enviar documentos para o MongoDB. Isso requer uma chave de API Voyage IA.

  • Incorporação automatizada do MongoDB: o MongoDB gera automaticamente incorporações no lado do servidor quando os documentos são inseridos ou atualizados. Para saber mais, consulte Incorporação automatizada do MongoDB.

Esses mecanismos funcionam de forma independente e podem ser usados juntos ou separadamente, dependendo do seu caso de uso.

A geração de embedding do MCP Server requer uma chave de API do Voyage AI configurada no MCP Server local e, portanto, está disponível apenas no MCP Server local. O embedding automatizado do MongoDB gera embedding dentro do MongoDB e não depende da configuração do MCP servidor.

Se você configurar o servidor MCP com uma chave de API do Voyage IA, o servidor poderá gerar automaticamente incorporações das seguintes maneiras:

  • Gerar incorporações para documentos: incorpora campos de texto em documentos ao usar a ferramenta insert-many.

  • Gera incorporações para queries: Incorpora a query de pesquisa ao executar consultas de pesquisa vetorial com a aggregate ferramenta. Especificamente, o servidor gera incorporações para o queryVector parâmetro em queries $vectorSearch de agregação do.

O servidor MCP suporta os seguintes modelos de incorporação do Voyage IA:

  • voyage-3-large

  • voyage-3.5

  • voyage-3.5-lite

  • voyage-code-3

Para aprender mais sobre os modelos de Voyage AI, veja a documentação de Voyage AI.

Observação

Por padrão, o servidor MongoDB MCP valida que os campos com índices de pesquisa vetorial contêm incorporações de vetor válidas para evitar a quebra de índices de pesquisa vetorial. Para desabilitar este comportamento, defina a opção disableEmbeddingsValidation como true. Para saber mais, consulte preferenceApiKey.

Importante

A incorporação automatizada em índices de pesquisa vetorial está disponível como recurso de visualização somente para o MongoDB Community Edition8 v.2 e versões posteriores. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização.

O MongoDB também pode gerar automaticamente incorporações no lado do servidor quando documentos são inseridos ou atualizados. Essa abordagem não requer uma chave de API do Voyage AI em sua configuração de MCP porque a geração de incorporação ocorre no MongoDB.

O servidor MongoDB MCP oferece suporte ao gerenciamento de índices de pesquisa vetorial com incorporação automatizada, que gera automaticamente incorporações para seus documentos. Você pode criar, descartar e inspecionar índices de pesquisa vetorial com incorporação automatizada por meio de prompts de linguagem natural. A tabela a seguir resume os principais recursos.

Para saber mais, consulte Embedding automatizada.

Caso de uso
Ferramentas relevantes
Exemplo de prompts

Gerenciar índices

create-index

collection-indexes

drop-index

"Crie um índice de pesquisa vetorial de incorporação automática no campo 'plot' em 'mflix.movies' namespace usando o modelo voyage-4-large."

Inserir dados com incorporações

insert-many

"Insira estes documentos com os seguintes campos e gere automaticamente embeddings..."

Query com incorporações

aggregate

"Execute uma query de pesquisa vetorial em mflix.movies com o índice de incorporação automática no campo'plote'."

O servidor MongoDB MCP oferece suporte à pré-filtragem de query de pesquisa vetorial. Para saber mais, consulte Pré-filtro.

O servidor MCP não suporta o campo quantization para índices de pesquisa vetorial.

A ferramenta atlas-get-performance-advisor permite acessar as recomendações do Performance Advisor por meio de querys de linguagem natural. Essa ferramenta ajuda você a identificar oportunidades de otimização de desempenho, analisando queries lentas e sugerindo melhorias.

Ao realizar a análise de query lenta, o servidor MongoDB MCP recupera uma amostra de queries lentas, limitada a 50 queries. A amostra inclui até 50 queries lentas mais recentes que correspondem a quaisquer condições especificadas em seu prompt para garantir o desempenho e os tempos de resposta ideais.

Observação

Esta ferramenta requer acesso ou superior e Project Read Only um10cluster M +. Execute esta ferramenta com o --readonly sinalizador.

Project Read Only refere-se à função de nível do projeto Atlas atribuída à sua conta de serviço, não a uma função do banco de dados.

Caso de uso
Exemplo de prompts
Operação do Performance Advisor

Analisar queries lentas

Show me my slow queries

What is slowing down my cluster?

Show me queries that are longer than 5 seconds

Show me slow writes in the website.users namespace

Sugestões de Índices

Are there any indexes I should create to improve performance?

What indexes do you recommend I drop?

Conselho sobre o esquema

Show schema recommendations for my cluster

Help me optimize my database schema

Para obter exemplos de uso detalhados e amostras de saída, consulte Otimização de desempenho.

Esta seção descreve o fluxo do servidor MCP atlas-connect-cluster local. Se você configurar o servidor MCP local sem especificar uma string de conexão com um Atlas cluster, a atlas-connect-cluster ferramenta usará as credenciais da conta de serviço configurada da API do Atlas para criar um usuário de banco de dados temporário e estabelecer uma conexão com o cluster.

O servidor MCP remoto usa uma ferramenta diferente, remote-atlas-connect, que segue seu próprio modelo de conexão e sessão e retorna um identificador de conexão para operações de banco de dados subsequentes.

O usuário de banco de dados temporário tem as seguintes características:

  • Nome de usuário e senha gerados aleatoriamente.

  • Por padrão, expira após 4 horas.

  • Função atribuída com base em como você configurou o servidor MCP:

Observação

O servidor MongoDB MCP armazena credenciais de usuário apenas na memória e nunca retorna ou expõe as credenciais no contexto LLM.

Para desabilitar FERRAMENTAS específicos e restringir o servidor MCP ao modo somente leitura, consulte Configuração do servidor MCP do MongoDB.

Para ver alguns exemplo de prompts de linguagem natural do servidor MCP, consulte Exemplos de uso do servidor MCP do MongoDB.