@neon/tools 2.8.0 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/generated/zod.gen.d.ts +312 -312
- package/dist/generated/zod.gen.d.ts.map +1 -1
- package/dist/generated/zod.gen.js +1896 -1426
- package/dist/lib/ergonomic/catalog.d.ts +25 -0
- package/dist/lib/ergonomic/catalog.d.ts.map +1 -1
- package/dist/lib/ergonomic/catalog.js +2 -1
- package/dist/lib/ergonomic/composed.d.ts +38 -0
- package/dist/lib/ergonomic/composed.d.ts.map +1 -1
- package/dist/lib/ergonomic/composed.js +44 -4
- package/dist/lib/ergonomic/ids.d.ts +2 -2
- package/dist/lib/ergonomic/ids.d.ts.map +1 -1
- package/dist/lib/ergonomic/ids.js +7 -2
- package/dist/operations.gen.js +20 -20
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -114,7 +114,7 @@ An abort `signal` on `execute` or a wait timeout stops the poll, not the create:
|
|
|
114
114
|
|
|
115
115
|
`metadata.method` and `metadata.path` name the first request; extra readiness GETs are not listed there.
|
|
116
116
|
|
|
117
|
-
These public client methods are not tools: `operations.waitFor`, `postgres.roles.password`, `storage.objects.get`, and `
|
|
117
|
+
These public client methods are not tools: `operations.waitFor`, `postgres.roles.password`, `storage.objects.get`, `credentials.reveal`, `logs.loki.labels`, and `logs.loki.labelValues`. Waiting is what the write tools already do. Loki labels are the log fields, so `logs.fields` and `logs.fieldValues` are the discovery tools for both `logs.query` and `logs.loki.queryRange`; the latter returns Loki's response, with lines grouped by stream labels, and nanosecond timestamp strings. `realtime.secret` is a GET that requires approval: it returns the branch's Realtime secret, which an application backend seals queries with. After `realtime.rotateSecret`, it returns the new value once `pending` is `false`. `projects.create` and `branches.create` return the created resource without a connection string; `createAndConnect` returns a URI. `triggers.create` and `triggers.update` take the OpenAPI discriminator as a nested `body` field. `credentials.rotate` requires approval and is not idempotent: a lost success already replaced the secret; create a replacement and revoke the rotated credential.
|
|
118
118
|
|
|
119
119
|
## Roles
|
|
120
120
|
|
|
@@ -139,7 +139,7 @@ const { data: role } = await tools["postgres.roles.create"].execute({
|
|
|
139
139
|
|
|
140
140
|
Pass a map keyed by SDK path or the current published `id`, or a function that can append to the generated text. A key that matches neither is ignored.
|
|
141
141
|
|
|
142
|
-
Generated Management API tools use the first sentence of the OpenAPI description (title stays the OpenAPI summary). Composed tools keep their handwritten copy. Hosts that need more still pass `descriptions`.
|
|
142
|
+
Generated Management API tools use the first sentence of the OpenAPI description (title stays the OpenAPI summary). Every top-level input carries a description too: the first sentence of its OpenAPI description, or handwritten copy where the spec has none. Composed tools keep their handwritten copy. Hosts that need more still pass `descriptions`.
|
|
143
143
|
|
|
144
144
|
```ts
|
|
145
145
|
const tools = createNeonTools({
|
|
@@ -300,7 +300,7 @@ Existing MCP 1.x servers can use the version-specific entry point:
|
|
|
300
300
|
import { registerNeonTools } from "@neon/tools/mcp-v1";
|
|
301
301
|
```
|
|
302
302
|
|
|
303
|
-
MCP 1.x still receives Zod input schemas, including
|
|
303
|
+
MCP 1.x still receives Zod input schemas, including their `.describe()` copy. Generated Zod carries only the first sentence of each OpenAPI field description. Use `compactJsonSchema` if you convert those schemas yourself and need `$schema` removed.
|
|
304
304
|
|
|
305
305
|
The adapter returns both text content and object-valued `structuredContent`. Execution failures use `isError: true` with `{ error: { message, name, kind, status, code, source, timeoutMs, requestId, reason, operationId } }` when those fields exist on the thrown error. A wait timeout has `kind: "timeout"` and `source: "wait"`.
|
|
306
306
|
|