SuperAPI AI 工具集

agent-paste-neon-postgres

数据与分析

查看项目

更新于 10-16 08:26

技能介绍

用途

该技能用于在涉及 Neon Serverless Postgres 的任务中为用户提供指导,包括初始设置、连接方式、分支以及高级功能。目标是交付可用的 Neon 连接、完成的功能配置,或基于 Neon 官方文档给出具体答案。

Neon 是一个无服务器 Postgres 平台,将计算与存储分离,提供自动扩缩容、分支、即时恢复和缩容至零能力,并与 Postgres 完全兼容,可用于任何支持 Postgres 的语言、框架或 ORM。

文档来源与获取方式

Neon 官方文档是所有 Neon 相关信息的唯一事实来源。技能要求始终对照官方文档核实说法,优先获取当前文档而非依赖训练数据。

文档页面可通过两种方式获取为 Markdown:

  • 在 URL 后追加 .md,例如:https://neon.com/docs/introduction/branching.md
  • 在标准 URL 上请求 text/markdown:curl -H "Accept: text/markdown" https://neon.com/docs/introduction/branching

文档索引列出所有页面及其 URL 与简短描述:https://neon.com/docs/llms.txt。若需要未列出的页面,应搜索该索引,不要猜测 URL。

主要能力与主题

  • 架构与术语:组织、项目、分支、端点等概念说明。链接:https://neon.com/docs/introduction/architecture-overview.md
  • 连接方式与驱动选择:根据运行时约束(TCP、HTTP、WebSocket、边缘、无服务器、长运行)选择传输与驱动。链接:https://neon.com/docs/connect/choose-connection.md
  • 无服务器驱动:@neondatabase/serverless 模式,包括 HTTP 查询、WebSocket 事务及运行时特定优化。链接:https://neon.com/docs/serverless/serverless-driver.md
  • Neon JS SDK:结合 Neon Auth 与类型化客户端设置。链接:https://neon.com/docs/reference/javascript-sdk.md
  • 开发者工具:本地开发启用、VSCode 扩展、MCP 服务器配置。相关链接:CLI Init 命令 https://neon.com/docs/reference/cli-init.md;VSCode 扩展 https://neon.com/docs/local/vscode-extension.md;MCP 服务器 https://neon.com/docs/ai/neon-mcp-server.md;Neon CLI https://neon.com/docs/reference/neon-cli.md
  • Neon CLI:面向终端优先工作流、脚本与 CI/CD 自动化。链接:https://neon.com/docs/reference/neon-cli.md
  • 编程式管理:默认通过 Neon CLI 或 MCP 进行代理驱动的资源管理;仅在用户明确要求将 Neon 管理嵌入应用代码时,才使用服务客户端集成。TypeScript SDK(@neondatabase/api-client)链接:https://neon.com/docs/reference/typescript-sdk.md;Python SDK(neon-api 包)链接:https://neon.com/docs/reference/python-sdk.md
  • Neon Auth:托管用户认证设置、UI 组件、认证方法及在 Next.js 与 React 应用中的集成注意事项。链接:https://neon.com/docs/auth/overview.md。Neon Auth 也内嵌于 Neon JS SDK 中。
  • 分支:即时、写时复制的克隆(不复制完整数据),每个分支有自己的计算端点,可用 neonctl CLI 或 MCP 服务器创建、检查与比较分支。链接:https://neon.com/docs/introduction/branching.md。详细分支工作流技能:https://neon.com/docs/ai/skills/neon-postgres-branches/SKILL.md,安装命令:npx skills add neondatabase/agent-skills --skill neon-postgres-branches
  • 自动扩缩容:计算随工作负载自动扩缩,涉及 CU 规格与运行时行为。链接:https://neon.com/docs/introduction/autoscaling.md
  • 缩容至零:空闲计算自动挂起(默认 5 分钟,可配置;除非禁用——仅限 launch 与 scale 计划),挂起后首次查询通常有冷启动开销(约数百毫秒),计算挂起期间存储保持活跃。链接:https://neon.com/docs/introduction/scale-to-zero.md
  • 即时恢复:支持时间点恢复,历史窗口取决于计划限制,可从历史时间点创建分支,Time Travel 查询可用于历史检查工作流。链接:https://neon.com/docs/introduction/branch-restore.md
  • 只读副本:只读计算端点共享同一存储,创建快速且扩缩独立于主计算,典型用例为分析、报表与读密集型 API。链接:https://neon.com/docs/introduction/read-replicas.md
  • 连接池:使用 PgBouncer,在端点主机名中添加 -pooler 以使用池化连接,在突发并发的无服务器运行时尤为重要。链接:https://neon.com/docs/connect/connection-pooling.md
  • IP 允许列表:按可信网络、IP 或 CIDR 范围限制数据库访问。链接:https://neon.com/docs/introduction/ip-allow.md
  • 逻辑复制:支持原生逻辑复制工作流,适用于与外部 Postgres 系统之间复制,以及 CDC 管道、外部同步等。链接:https://neon.com/docs/guides/logical-replication-guide.md

使用方式

自驱动设置(CLI 或 MCP)

可提供检查现有已连接 Neon 项目或创建新项目的能力。若两者均未设置,运行带 --agent 标志的 init。使用 npx -y 跳过包安装提示,认证自动处理;若用户未登录,会打开浏览器进行 OAuth 并等待完成。

命令:npx -y neonctl@latest init --agent <agent-name>

支持的 --agent 值:cursor、copilot、claude、claude-desktop、codex、opencode、cline、gemini-cli、goose、zed。

该命令会安装 Neon 扩展(Cursor/VS Code)或 MCP 服务器(其他代理),配置所需集成凭据,并在默认上游设置中将源 neon-postgres 代理技能添加到项目。在本仓库中,检入的技能名称保持前缀 agent-paste-neon-postgres。

若 init 不适用,可非交互式运行各步骤:

  • 扩展:cursor --install-extension databricks.neon-local-connect
  • MCP 服务器:npx -y add-mcp https://mcp.neon.tech/mcp -g -n Neon -y -a <agent-name>
  • 代理技能:npx skills add neondatabase/agent-skills --skill neon-postgres --agent <agent-name> -y

完整 CLI 安装选项见 https://neon.com/docs/reference/cli-install.md

设置流程

  1. 选择组织与项目:使用 MCP 服务器或 CLI 列出组织与项目,让用户选择现有项目或创建新项目。
  2. 获取连接串:使用 MCP 服务器或 CLI 获取连接串,存入 .env 的 DATABASE_URL。修改前先读取文件,避免覆盖已有值。
  3. 选择连接方式与驱动:参考连接方式指南,根据部署平台选择正确驱动。链接:https://neon.com/docs/connect/choose-connection.md
  4. 使用 Neon Auth 进行用户认证(如需要):CLI 工具、脚本或无用户账户的应用可跳过。若应用需要认证,使用 MCP 服务器的 provision_neon_auth 工具,然后参考认证概览 https://neon.com/docs/auth/overview.md。认证加数据库查询见 JavaScript SDK 参考 https://neon.com/docs/reference/javascript-sdk.md
  5. ORM 设置(可选):检查现有 ORM(Prisma、Drizzle、TypeORM)。若没有,询问是否需要。Drizzle 集成见 https://neon.com/docs/guides/drizzle.md
  6. Schema 设置:检查现有迁移文件或 ORM schema;若没有,可提供创建示例 schema 或共同设计。

恢复支持:若恢复设置,检查已配置内容(MCP 连接、含 DATABASE_URL 的 .env、依赖、schema),从下一个未完成步骤继续。

安全提醒

提醒用户使用环境变量存储凭据,切勿提交连接串,并使用最小权限数据库角色。

适用场景

适用于任何 Neon 相关任务:首次设置、连接方式选择、分支与环境隔离、Schema 迁移测试、预览部署、分支生命周期自动化、自动扩缩容与 CU 规格、空闲成本优化与挂起/恢复、时间点恢复、读密集型工作负载、无服务器或高并发环境的连接管理、按网络/IP 限制访问、CDC 管道与外部 Postgres 同步等。

限制

资料未提供该技能的具体收费、价格、平台支持范围或效果数据。Neon 功能与 API 会演进,应以官方文档为准。