Home/Tools/@tpmjs/tools-neon

listOperations

@tpmjs/tools-neon

List recent operations for a Neon project.

Official
ops
v0.1.0
MIT

Interactive Playground

Test @tpmjs/tools-neon (listOperations) with AI-powered execution

0/2000 characters

Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-neon
pnpm add @tpmjs/tools-neon
yarn add @tpmjs/tools-neon
bun add @tpmjs/tools-neon
deno add npm:@tpmjs/tools-neon

2. Import the tool

import { listOperations } from '@tpmjs/tools-neon';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { listOperations } from '@tpmjs/tools-neon';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { listOperations },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Signature

(projectId: string, limit?: number) => Promise<unknown>

Tags

agent
database
list
neon
operations
ops
postgres
project
recent
serverless
tpmjs

Parameters

Available configuration options

Auto-extracted
projectId
Required
Type: string

Neon project ID.

limit
Optional
Type: number

Number of operations to return (max 400, default 10).

Schema extracted: 2/28/2026, 4:02:05 AM

README

@tpmjs/tools-neon

Neon serverless Postgres tools for AI agents. Manage projects, branches, databases, compute endpoints, and usage metrics.

Installation

npm install @tpmjs/tools-neon

Setup

Set the NEON_API_KEY environment variable. Get your key from https://console.neon.tech/app/settings/api-keys

Usage

import { listProjects, getConsumption } from '@tpmjs/tools-neon';

// List all projects
const projects = await listProjects.execute({});

// Get usage metrics
const usage = await getConsumption.execute({
  from: '2025-01-01T00:00:00Z',
  to: '2025-02-01T00:00:00Z',
  granularity: 'daily',
});

Tools

NameDescription
listProjectsList all Neon projects with optional search filtering
getProjectGet details of a specific Neon project by ID
createProjectCreate a new project with default branch and database
deleteProjectPermanently delete a project and all resources
listBranchesList all branches in a project
createBranchCreate a branch (instant copy-on-write fork)
deleteBranchDelete a branch
listDatabasesList databases on a branch
createDatabaseCreate a database on a branch
deleteDatabaseDelete a database
listEndpointsList compute endpoints and their status
startEndpointStart a suspended compute endpoint
suspendEndpointSuspend an endpoint to save costs
getConnectionUriGet a PostgreSQL connection string
listOperationsList recent async operations
getConsumptionGet usage metrics (compute, storage, data)

License

MIT

Statistics

Downloads/month

52

GitHub Stars

8

Quality Score

85%

Bundle Size

NPM Keywords

tpmjs
neon
postgres
database
serverless
agent

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai