ComposioHQ/Neon-Automation

Automação Neon

Automatize seus workflows do Neon (Postgres serverless) — liste projetos e branches, inspecione bancos de dados, obtenha URIs de conexão, gerencie funções e integre operações de banco de dados Neon em pipelines entre aplicações.

Documentação do toolkit: composio.dev/toolkits/neon

---

Configuração

1. Adicione o servidor MCP do Composio ao seu cliente: https://rube.app/mcp
2. Conecte sua conta do Neon quando solicitado (autenticação via chave de API)
3. Comece a usar os workflows abaixo

---

Workflows Principais

1. Listar Projetos

Use NEON_RETRIEVE_PROJECTS_LIST para descobrir todos os projetos associados ao usuário autenticado.

Ferramenta: NEON_RETRIEVE_PROJECTS_LIST
Entradas:
  - org_id: string (OBRIGATÓRIO ao usar chave de API pessoal)
  - limit: integer (1-400, padrão 10)
  - cursor: string (cursor de paginação da resposta anterior)
  - search: string (pesquisar por nome ou ID do projeto, suporta correspondência parcial)
  - timeout: integer (milissegundos; retorna resultados parciais em caso de timeout)

Importante: Ao usar uma chave de API pessoal, org_id é obrigatório. Recupere-o primeiro via NEON_GET_USER_ORGANIZATIONS.

2. Obter Detalhes do Projeto

Use NEON_ACCESS_PROJECT_DETAILS_BY_ID para inspecionar configuração do projeto, informações do proprietário e métricas de consumo.

Ferramenta: NEON_ACCESS_PROJECT_DETAILS_BY_ID
Entradas:
  - project_id: string (obrigatório) -- formato: "adjetivo-substantivo-número", ex.: "dry-smoke-26258271"

3. Listar Branches de um Projeto

Use NEON_GET_BRANCHES_FOR_PROJECT para enumerar branches (estágios de desenvolvimento) dentro de um projeto.

Ferramenta: NEON_GET_BRANCHES_FOR_PROJECT
Entradas:
  - project_id: string (obrigatório)
  - search: string (opcional, pesquisar por nome ou ID do branch)

4. Listar Bancos de Dados em um Branch

Use NEON_FETCH_DATABASE_FOR_BRANCH para inventariar bancos de dados dentro de um projeto e branch específicos.

Ferramenta: NEON_FETCH_DATABASE_FOR_BRANCH
Entradas:
  - project_id: string (obrigatório)
  - branch_id: string (obrigatório)

5. Obter URI de Conexão

Use NEON_GET_PROJECT_CONNECTION_URI para obter uma string de conexão Postgres para um projeto/branch/banco de dados.

Ferramenta: NEON_GET_PROJECT_CONNECTION_URI
Entradas:
  - project_id: string (obrigatório)
  - database_name: string (obrigatório) -- ex.: "neondb"
  - role_name: string (obrigatório) -- ex.: "neondb_owner"
  - branch_id: string (opcional, padrão é o branch padrão do projeto)
  - endpoint_id: string (opcional, padrão é o endpoint de leitura/escrita)
  - pooled: boolean (opcional, adiciona -pooler para pooling de conexão)

Segurança: A URI retornada inclui credenciais. Trate-a como um segredo — não registre ou compartilhe.

6. Inspecionar Detalhes do Banco de Dados e Funções

Use NEON_RETRIEVE_BRANCH_DATABASE_DETAILS para verificar um banco de dados antes de conectar, e NEON_GET_BRANCH_ROLES_FOR_PROJECT para listar funções disponíveis.

Ferramenta: NEON_RETRIEVE_BRANCH_DATABASE_DETAILS
Entradas:
  - project_id: string (obrigatório)
  - branch_id: string (obrigatório)
  - database_name: string (obrigatório)

Ferramenta: NEON_GET_BRANCH_ROLES_FOR_PROJECT
Entradas:
  - project_id: string (obrigatório)
  - branch_id: string (obrigatório)

---

Armadilhas Conhecidas

Armadilha	Detalhe
org_id obrigatório	NEON_RETRIEVE_PROJECTS_LIST retorna HTTP 400 "org_id is required" ao usar chave de API pessoal. Chame NEON_GET_USER_ORGANIZATIONS primeiro.
Paginação incompleta	Listas de projetos podem estar incompletas sem paginação. Itere usando cursor até que esteja vazio.
Limitação de taxa	NEON_RETRIEVE_PROJECTS_LIST retorna HTTP 429 em listagens com rajadas. Evite chamadas redundantes e aguarde antes de tentar novamente.
Pareamento inválido função/banco	NEON_GET_PROJECT_CONNECTION_URI retorna 401/403 quando o pareamento database_name/role_name é inválido. Use NEON_GET_BRANCH_ROLES_FOR_PROJECT para selecionar uma função permitida.
URI de conexão é um segredo	A URI retornada inclui credenciais. Nunca registre, exiba ou compartilhe em texto simples.

---

Referência Rápida

Slug da Ferramenta	Descrição
NEON_RETRIEVE_PROJECTS_LIST	Listar todos os projetos Neon com paginação e pesquisa
NEON_ACCESS_PROJECT_DETAILS_BY_ID	Obter configuração do projeto e métricas de consumo
NEON_GET_BRANCHES_FOR_PROJECT	Listar branches dentro de um projeto
NEON_FETCH_DATABASE_FOR_BRANCH	Listar bancos de dados em um branch específico
NEON_GET_PROJECT_CONNECTION_URI	Obter uma URI de conexão Postgres (com credenciais)
NEON_RETRIEVE_BRANCH_DATABASE_DETAILS	Inspecionar metadados e configurações do banco de dados
NEON_GET_USER_ORGANIZATIONS	Listar organizações para o usuário autenticado
NEON_CREATE_API_KEY_FOR_ORGANIZATION	Criar uma nova chave de API para uma organização
NEON_GET_BRANCH_ROLES_FOR_PROJECT	Listar funções disponíveis em um branch

---

Powered by Composio