get_project
Get Project
Retrieves detailed information about a specific Neon project, including its configuration, connection URI, consumption metrics, and settings.
get_project
Retrieves detailed information about a specific Neon project, including its configuration, connection URI, consumption metrics, and settings.
list_projects
Lists all Neon projects accessible to the authenticated user. Supports searching by name or ID and filtering by organization. Returns project metadata including region, Postgres version, and timestamps.
list_branches
Lists all branches in a Neon project. Branches contain databases and can be created from any point in the project's history retention window.
get_operation
Retrieves the details and current status of a specific operation. Use this to poll for completion of asynchronous operations before proceeding with dependent tasks.
delete_database
Permanently deletes a database from a branch in a Neon project.
update_project
Updates an existing Neon project's settings, including its name and default endpoint configuration.
delete_endpoint
Deletes a compute endpoint from a Neon project. The branch and its data remain intact.
list_endpoints
Lists all compute endpoints in a Neon project. Endpoints are processing instances that connect to branches and provide database connectivity.
create_project
Creates a new Neon project. A project is the top-level organizational unit that contains branches, databases, and compute endpoints. You can specify the region, Postgres version, and default compute settings.
update_database
Updates a database's name or owner on a specific branch. Can be used to rename a database or transfer ownership to another role.
create_branch
Creates a new branch in a Neon project. Branches are copies of the parent branch's data at a specific point in time. Optionally creates a compute endpoint for the branch so it can accept connections.
delete_project
Permanently deletes a Neon project and all its branches, databases, endpoints, and roles. The project can be recovered within the deletion grace period using the recover project tool.
list_databases
Lists all databases on a specific branch in a Neon project. Each database belongs to a branch and has an owner role.
list_roles
Lists all database roles on a specific branch. Roles control database access and permissions. They are copied to child branches upon creation.
create_endpoint
Creates a new compute endpoint for a branch. Endpoints provide the processing power for running queries. Each branch supports one read-write endpoint and multiple read-only (replica) endpoints.
create_role
Creates a new database role on a branch. The role will be available for database access and can be assigned as a database owner.
restore_branch
Restores a branch to a previous state using a point-in-time timestamp or LSN. Optionally preserves the current state under a new branch name before restoring.
delete_role
Deletes a database role from a branch. The role must not own any databases.
get_consumption
Retrieves consumption metrics across all projects for the account. Tracks compute time, active time, storage, written data, and data transfer. Available on Neon paid plans.
control_endpoint
Starts, suspends, or restarts a compute endpoint. Use this to manage the lifecycle of compute instances — wake up suspended endpoints, suspend active ones to save costs, or restart for configuration changes.
create_database
Creates a new database on a branch in a Neon project. Each database requires an owner role. There is a limit of 500 databases per branch.
reset_role_password
Resets the password for a database role. Returns the new generated password. Use this when credentials need to be rotated or if the current password has been lost.
delete_branch
Deletes a branch from a Neon project. This also deletes all databases, roles, and compute endpoints associated with the branch.
update_endpoint
Updates a compute endpoint's autoscaling limits and suspend timeout configuration.
list_operations
Lists recent operations for a Neon project. Operations are asynchronous tasks like creating branches, starting compute endpoints, or applying configuration changes. Use this to track the progress and status of background tasks.
list_snapshots
Lists snapshots for a Neon project. Snapshots are point-in-time backups of project data.
update_branch
Updates a Neon branch name, protected flag, or expiration timestamp. Set expiresAt to null to remove the expiration timestamp.
set_default_branch
Sets a branch as the default branch for a Neon project. The previous default branch is automatically unset.
reveal_role_password
Retrieves the stored password for a Neon database role when password storage is enabled. Use reset_role_password when the password should be rotated instead.
restore_snapshot
Restores a Neon snapshot to a branch. By default Neon creates a restored branch for preview; set finalizeRestore only when you intend to replace the target branch.
get_branch
Retrieves details for a specific Neon branch, including its parent, state, default/protected flags, and timestamps.
recover_project
Recovers a deleted Neon project within the deletion recovery period. Restores branches, endpoints, settings, and connection strings when Neon can still recover the project.
update_snapshot
Renames a Neon project snapshot.
get_connection_uri
Retrieves a PostgreSQL connection URI for a Neon database and role. Use pooled=true to request a pooled connection URI.
create_snapshot
Creates a point-in-time snapshot from a Neon branch. Provide either lsn or timestamp to snapshot a specific historical point, not both.
get_role
Retrieves details for a database role on a Neon branch, including protection and authentication metadata.
get_database
Retrieves details for a specific database on a Neon branch, including owner role and timestamps.
recover_branch
Recovers a soft-deleted Neon branch within the deletion recovery period when branch recovery is available for the project.
get_endpoint
Retrieves details for a specific Neon compute endpoint, including state, host, autoscaling limits, suspend timeout, and access flags.
list_regions
Lists supported Neon regions. Use this before creating projects to choose a valid region ID. Pass orgId to see the regions available to a specific Neon organization.
delete_snapshot
Deletes a Neon project snapshot.
Manage serverless PostgreSQL databases on Neon. Create, update, and delete projects, branches, databases, compute endpoints, and roles. Configure autoscaling limits, suspend timeouts, and read replicas. Create branches from any point in time for development, testing, or backups. Compare schemas between branches and create anonymized data copies. Track consumption metrics including compute time, storage, and data transfer, and set quota limits. Manage organization members, permissions, and API keys. Monitor asynchronous operation status and query databases over HTTP via the Data API.
Common questions about connecting Neon to AI agents with Metorial.