Neon Serverless Postgres

Quando Usar

Use esta habilidade quando precisar de guias e melhores práticas para trabalhar com Neon Serverless Postgres. Abrange configuração, métodos de conexão, branching, autoscaling, scale-to-zero, réplicas de leitura, connection pooling, Neon Auth e o Neon CLI, servidor MCP, API REST, SDK TypeScript e SDK Python. Use quando os usuários perguntarem sobre...

Guie o usuário em qualquer tarefa relacionada ao Neon: configuração, conexões, branching e recursos avançados. Entregue uma conexão Neon funcional, uma configuração de recurso completa ou uma resposta específica da documentação oficial do Neon.

Neon é uma plataforma Postgres serverless que separa computação e armazenamento para oferecer autoscaling, branching, restauração instantânea e scale-to-zero. É totalmente compatível com Postgres e funciona com qualquer linguagem, framework ou ORM que suporte Postgres.

Documentação do Neon

A documentação do Neon é a fonte da verdade para todas as informações relacionadas ao Neon. Sempre verifique as afirmações contra a documentação oficial antes de responder. Os recursos e APIs do Neon evoluem, portanto, prefira buscar a documentação atual em vez de confiar em dados de treinamento.

Buscando Documentos como Markdown

Qualquer página de documentação do Neon pode ser buscada como markdown de duas maneiras:

1. Anexe .md à URL (mais simples): https://neon.com/docs/introduction/branching.md
2. Solicite text/markdown na URL padrão: curl -H "Accept: text/markdown" https://neon.com/docs/introduction/branching

Ambos retornam o mesmo conteúdo markdown. Use o método que suas ferramentas suportam.

Encontrando a Página Certa

O índice de documentação lista todas as páginas disponíveis com sua URL e uma breve descrição:

https://neon.com/docs/llms.txt

URLs de documentação comuns são organizadas nos links de tópicos abaixo. Se você precisar de uma página não listada aqui, pesquise no índice de documentação: https://neon.com/docs/llms.txt. Não adivinhe URLs.

O Que É Neon

Use isso para explicações de arquitetura e terminologia (organizações, projetos, branches, endpoints) antes de fornecer conselhos de implementação.

Link: https://neon.com/docs/introduction/architecture-overview.md

Primeiros Passos

Use esta seção ao guiar um usuário através da configuração inicial do Neon.

Verifique o Status Quo

Antes de iniciar a configuração, inspecione o código e o ambiente do usuário:

• Código de conexão de banco de dados existente
• Configuração existente do servidor Neon MCP ou Neon CLI
• Existência de um arquivo .env e variável de ambiente DATABASE_URL
• Configuração existente de ORM (Prisma, Drizzle, TypeORM)

Configuração Autônoma com o CLI do Neon ou Servidor MCP

Ofereça-se para inspecionar projetos Neon conectados existentes ou criar novos usando o Neon CLI ou o servidor MCP. Se nenhum deles estiver configurado ainda, execute init com o sinalizador --agent. Use npx -y para pular o prompt de instalação do pacote. A autenticação é tratada automaticamente. Se o usuário não estiver logado, ele abrirá o navegador para OAuth e aguardará a conclusão antes de prosseguir.

npx -y neon@latest init --agent <agent-name>

Valores --agent suportados: cursor, copilot, claude, claude-desktop, codex, opencode, cline, gemini-cli, goose, zed.

Isso instala a extensão Neon (para Cursor/VS Code) ou o servidor MCP (para outros agentes), cria uma chave de API e adiciona a habilidade de agente neon-postgres ao projeto.

Se init não for adequado, as etapas individuais podem ser executadas de forma não interativa:

• Extensão: cursor --install-extension databricks.neon-local-connect
• Servidor MCP: npx -y add-mcp https://mcp.neon.tech/mcp -g -n Neon -y -a <agent-name>
• Habilidade de agente: npx skills add neondatabase/agent-skills --skill neon-postgres --agent <agent-name> -y

Para opções completas de instalação do CLI, consulte https://neon.com/docs/reference/cli-install.md

Fluxo de Configuração

1. Selecione Organização e Projeto

Use o servidor MCP ou o CLI para listar organizações e projetos. Deixe o usuário selecionar um projeto existente ou criar um novo.

2. Obtenha a String de Conexão

Use o servidor MCP ou o CLI para obter a string de conexão. Armazene-a em .env como DATABASE_URL. Leia o arquivo primeiro antes de modificar para evitar sobrescrever valores existentes.

3. Escolha o Método de Conexão e Driver

Consulte o guia de métodos de conexão para escolher o driver correto com base na plataforma de implantação: https://neon.com/docs/connect/choose-connection.md

4. Autenticação do Usuário com Neon Auth (se necessário)

…