Skip to content
API Reference
Neon logo

Neon

Developer Tools

Serverless Postgres with branching and autoscaling

Manage Neon Postgres databases directly from your AI assistant. Create and manage database branches, run SQL queries, manage roles and permissions, and monitor database performance without leaving your coding environment.

Add Neon to your zone and connect it to your MCP client.

  1. In your zone’s Keycard Console, go to Applications -> Add Application -> Explore MCP Servers.

  2. Search for Neon and click Install.

  3. A browser tab opens to Neon’s OAuth consent screen. Sign in and approve the requested permissions.

  4. You’re redirected back. Neon appears on the Applications page with a Keycard MCP Gateway URL.

On the Applications page, click Add to Coding Agent next to Neon and pick how you want to install:

  • Cursor - opens a deeplink that hands the MCP config straight to Cursor. Click Install inside Cursor to finish.
  • Claude Code - opens a dialog with a claude mcp add command. Pick a scope (User, Project, or Local), then copy and run the command in your terminal.
  • Install manually - reveals the Server Name and Server URL to paste into any other MCP-compatible client.

Once connected, Neon’s tools are available to the agent, scoped to whoever signs in to your zone.

What Neon can do once installed.

Neon provides 29 tools:

list_projects
Lists Neon projects with pagination and optional search filters
list_shared_projects
List Neon projects shared with current user
describe_project
Get detailed metadata for a Neon project
Create a new Neon project
Creates a new Neon project
Delete a Neon project
Deletes a Neon project
list_organizations
List accessible organizations with filters
create_branch
Create a new branch in a Neon project
delete_branch
Delete a branch from a Neon project
describe_branch
Get branch tree: databases, schemas, tables, views
list_branch_computes
List compute endpoints for a project or branch
compare_database_schema
Diff branch schema against parent with migration plan
reset_from_parent
Reset a branch to match its parent state
get_connection_string
Generate a PostgreSQL connection string
run_sql
Run a single SQL statement on a Neon database
run_sql_transaction
Run multiple SQL statements as a transaction
get_database_tables
List all tables in a Neon database
describe_table_schema
Get table schema details in a Neon database
prepare_database_migration
Validate migration SQL on a temporary branch
complete_database_migration
Apply approved migration and clean up temp branch
provision_neon_auth
Set up Neon Auth for a branch
provision_neon_data_api
Set up Neon Data API for a branch
explain_sql_statement
Run EXPLAIN or EXPLAIN ANALYZE on a SQL statement
prepare_query_tuning
Analyze query performance and propose optimizations
complete_query_tuning
Apply or discard query tuning changes
list_slow_queries
List slow queries from pg_stat_statements
search
Search across content in the workspace
fetch
Get any object by its ID
list_docs_resources
List available Neon documentation pages
get_doc_resource
Get a Neon doc page as markdown by slug

What to do once Neon is installed.

Now do this

  • Confirm the gateway works by asking your AI client to call one of the Neon tools above.

Recommended

  • Decide who can use it - write access policies scoped to the Neon resource so only the right users and agents reach the tools.
  • Watch the calls - every tool call lands in your audit log with user identity, resource, and policy decision.