neon-python-sdk

A set of rules for using Neon's Python SDK, a Python library for managing hosted PostgreSQL projects and their resources through an API.

In plain words
What is it for?
Programmatically managing Neon projects, branches, databases, and related resources with Python.
Why use it?
It gives agents consistent patterns for working with Neon resources from Python instead of handling raw API requests themselves.

Cursor rule

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/neondatabase/ai-rules/neon-python-sdk
Clone the repo
git clone --depth 1 https://github.com/neondatabase/ai-rules
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 8,146 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.08146
Opus 5 $0.00000 $0.04073
Sonnet 5 $0.00000 $0.01629
Haiku 4.5 $0.00000 $0.00815

Measured 2d ago against content hash a616320da75f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

neon-python-sdk scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

neon-python-sdk.mdc · 1,094 lines

How it starts

The opening of the file, as written. The whole thing — 1,094 lines — stays where its author put it; the contents beside it link to each section on GitHub.

This file provides comprehensive rules and best practices for interacting with the Neon API using the neon-api Python SDK. Following these guidelines will enable an AI agent like you to build robust, efficient, and error-tolerant integrations with Neon.

The SDK is a Pythonic wrapper around the Neon REST API and provides methods for managing all Neon resources, including projects, branches, endpoints, roles, and databases.

Neon Core Concepts

To effectively use the Neon Python SDK, it's essential to understand the hierarchy and purpose of its core resources. The following table provides a high-level overview of each concept.

Concept Description Analogy/Purpose Key Relationship
Organization The highest-level container, managing billing, users, and multiple projects. A GitHub Organization or a company's cloud account. Contains one or more Projects.
Project The primary container that contains all related database resources for a single application or service. A Git repository or a top-level folder for an application. Lives within an Organization (or a personal account). Contains Branches.
Branch A lightweight, copy-on-write clone of a database's state at a specific point in time. A git branch. Used for isolated development, testing, staging, or previews without duplicating storage costs. Belongs to a Project. Contains its own set of Databases and Roles, cloned from its parent.
Compute Endpoint The actual running PostgreSQL instance that you connect to. It provides the CPU and RAM for processing queries. The "server" or "engine" for your database. It can be started, suspended (scaled to zero), and resized. Is attached to a single Branch. Your connection string points to a Compute Endpoint's hostname.
Database A logical container for your data (tables, schemas, views) within a branch. It follows standard PostgreSQL conventions. A single database within a PostgreSQL server instance. Exists within a Branch. A branch can have multiple databases.
Role A PostgreSQL role used for authentication (logging in) and authorization (permissions to access data). A database user account with a username and password. Belongs to a Branch. Roles from a parent branch are copied to child branches upon creation.
API Key A secret token used to authenticate requests to the Neon API. Keys have different scopes (Personal, Organization, Project-scoped). A password for programmatic access, allowing you to manage all other Neon resources. Authenticates actions on Organizations, Projects, Branches, etc.
Operation An asynchronous action performed by the Neon control plane, such as creating a branch or starting a compute. A background job or task. Its status can be polled to know when an action is complete. Associated with a Project and often a specific Branch or Endpoint. Essential for scripting API calls.

Read the full file on GitHub · 1,094 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 1,094 lines · 8,146 tokens per session scan A a616320da75f

Subscribe to this mod's changes

neon-python-sdk is a cursor rule published in the GitHub repository neondatabase/ai-rules (86 stars, last pushed 3mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 8,146 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.