Skip to content

API and MCP tools

Look up selected endpoints and corresponding tools; this is not the complete API contract.

Updated View as Markdown

This table indexes common operations from the current Go router and MCP tools. It is not a full endpoint inventory, complete OpenAPI specification or a promise of versioned API stability.

Common operations

Task Go API MCP tool
Key identity Authenticated by the MCP layer neon_whoami
List projects GET /api/projects neon_list_projects
Project detail GET /api/projects/{id} neon_get_project
List branches GET /api/projects/{id}/branches neon_list_branches
List computes GET /api/computes neon_list_computes
Compute detail GET /api/computes/{id} neon_get_compute
Compute databases GET /api/computes/{id}/databases neon_list_databases
Credential-bearing URL GET /api/computes/{id}/connection neon_get_connection_url
Execute SQL POST /api/sql neon_execute_sql
Schema GET /api/sql/schema neon_get_schema
Backups GET /api/backups neon_list_backups
Compute regions GET /api/k8s/regions neon_list_regions

REST entries explain the product contract. Agents exposing MCP tools must use them for supported operations, preserving scope checks, confirmation and audit.

SQL limits through MCP

neon_execute_sql takes compute_id, database, query, max_rows (1–1000, default 100) and timeout_seconds (1–60, default 30). These are tool limits, not a guarantee that every query will complete within that time.

Read-only example: replace the compute ID with a resource whose access you have verified.

{
  "compute_id": "VERIFIED_COMPUTE_ID",
  "database": "neondb",
  "query": "SELECT current_database(), current_user;",
  "max_rows": 10,
  "timeout_seconds": 10
}

Secrets and confirmation

A connection tool can return a password in its URL. It requires credentials:read; do not copy its result to chat, logs or docs. Deletion, suspension, password rotation and overwrite-capable restore have separate confirmation rules. Read the MCP workflow before calling them.

Navigation

Type to search…

↑↓ navigate↵ open resultEsc close