Neon Extension

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import CLIExtensionInstructions from '@site/src/components/CLIExtensionInstructions'; import GooseDesktopInstaller from '@site/src/components/GooseDesktopInstaller'; import { PanelLeft } from 'lucide-react';

This tutorial covers how to add the Neon MCP Server as a goose extension to interact with your Neon Postgres databases and manage your projects, branches, and more.

Neon offers two versions of the MCP server:

1. Remote MCP server hosted by Neon, which redirects you to neon.com to sign in to your Neon account.
2. Local MCP server that you can run on your own machine using an API key to connect with a specific organization or your personal account.

:::warning Security Note The Neon MCP Server grants powerful database management capabilities and is intended for local development only - always review LLM-requested actions before execution and avoid using in production environments. :::

Configuration

<Tabs groupId="remote-or-local"> <TabItem value="remote" label="Neon Remote MCP" default> :::tip Quick Install <Tabs groupId="interface"> <TabItem value="ui" label="goose Desktop" default> [Launch the installer](goose://extension?type=streamable_http&url=https%3A%2F%2Fmcp.neon.tech%2Fmcp&id=neon&name=Neon&description=Manage%20Neon%20Postgres%20databases%2C%20projects%2C%20and%20branches) </TabItem> <TabItem value="cli" label="goose CLI"> Use `goose configure` to add a `Remote Extension (Streaming HTTP)` extension type with: </Tabs> :::

:::info OAUTH FLOW An OAuth window will open in your browser. Follow the prompts to authorize access to your Neon account. :::

<Tabs groupId="interface"> <TabItem value="ui" label="goose Desktop" default> <GooseDesktopInstaller extensionId="neon" extensionName="Neon" description="Manage Neon Postgres databases, projects, and branches" type="http" url="https://mcp.neon.tech/mcp" /> </TabItem> <TabItem value="cli" label="goose CLI"> <CLIExtensionInstructions name="neon-mcp-remote" description="Manage Neon Postgres databases, projects, and branches" type="http" url="https://mcp.neon.tech/mcp" timeout={300} /> </TabItem> </Tabs> </TabItem> <TabItem value="local" label="Neon Local MCP"> :::tip Quick Install <Tabs groupId="interface"> <TabItem value="ui" label="goose Desktop" default> [Launch the installer](goose://extension?cmd=npx&arg=-y&arg=%40neondatabase%2Fmcp-server-neon&arg=start&arg=%3CYOUR_NEON_API_KEY%3E&id=neon&name=Neon&description=Manage%20your%20Neon%20Postgres%20databases%2C%20projects%2C%20and%20branches) </TabItem> <TabItem value="cli" label="goose CLI"> **Command** ```sh npx -y @neondatabase/mcp-server-neon start <YOUR_NEON_API_KEY> ``` </Tabs> :::

:::info Prerequisites

• Node.js (v18.0.0 or higher) installed on your system to run this command, as it uses npx
• Neon API key to authenticate the Neon MCP Server with your Neon account. You can create one from the Neon Console under your Profile settings. Refer to the Neon documentation on API Keys for detailed instructions. :::

<Tabs groupId="interface"> <TabItem value="ui" label="goose Desktop" default> <GooseDesktopInstaller extensionId="neon" extensionName="Neon" description="Manage your Neon Postgres databases, projects, and branches" command="npx" args={["-y", "@neondatabase/mcp-server-neon", "start", "<YOUR_NEON_API_KEY>"]} /> </TabItem> </Tabs> </TabItem> </Tabs>

For all setup and configuration options, see the official Neon MCP Server documentation.

Example Usage 1

Get an overview of all your Neon database projects and their configurations.

goose Prompt

goose Output

Example Usage 2

Discover what tables and schemas exist within a specific project.

goose Prompt

goose Output

Example Usage 3

Run queries against your database tables to retrieve and analyze your data.

goose Prompt

goose Output