Neon

Neon serverless Postgres: list and inspect projects, list and create branches, list databases.

5 actions API key 4 read1 write Calls console.neon.tech

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "neon" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Create branchwriteneon.create_branchCreate a branch of a Neon project, by default from the project's default branch (copy-on-write). No compute endpoint is created.

Input	Type		Description
`project_id`	string	Required	Project ID
`name`	string	Optional	Branch name (auto-generated if omitted)
`parent_id`	string	Optional	Parent branch ID (br-...); defaults to the default branch

TypeScript

await setu.execute({
  userId: "user_1",
  action: "neon.create_branch",
  input: {
    "project_id": "<project_id>"
  },
});

Get projectreadneon.get_projectGet a Neon project: region, Postgres version, proxy host and timestamps.

Input	Type		Description
`project_id`	string	Required	Project ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "neon.get_project",
  input: {
    "project_id": "<project_id>"
  },
});

List branchesreadneon.list_branchesList the branches of a Neon project with their IDs, names and parents.

Input	Type		Description
`project_id`	string	Required	Project ID
`search`	string	Optional	Partial match on branch name or ID
`limit`	integer	Optional	Records per page

TypeScript

await setu.execute({
  userId: "user_1",
  action: "neon.list_branches",
  input: {
    "project_id": "<project_id>"
  },
});

List databasesreadneon.list_databasesList the databases of a branch with their owner roles.

Input	Type		Description
`project_id`	string	Required	Project ID
`branch_id`	string	Required	Branch ID (br-...)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "neon.list_databases",
  input: {
    "project_id": "<project_id>",
    "branch_id": "<branch_id>"
  },
});

List projectsreadneon.list_projectsList Neon projects, optionally filtered by a name or ID search; personal API keys must pass org_id.

Input	Type		Description
`search`	string	Optional	Partial match on project name or ID
`limit`	integer	Optional	Number of projects, 1 to 400
`cursor`	string	Optional	Cursor from a previous page
`org_id`	string	Optional	Organization ID (required for personal API keys)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "neon.list_projects",
  input: {},
});