@neon/tools 2.10.0 → 2.11.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 CHANGED
@@ -102,6 +102,14 @@ Paginated lists call `.all()` and return the item array. Do not pass a cursor; t
102
102
  const createBranch = createNeonTool("branches.createAndConnect", { apiKey });
103
103
  ```
104
104
 
105
+ `incidents.list` (`list_incidents`) is the exception to the credential rule. It reads neonstatus.com, needs no credential, and never sends one, so it works for anonymous agents:
106
+
107
+ ```ts
108
+ const incidents = createNeonTool("incidents.list", {});
109
+ const { data } = await incidents.execute({});
110
+ // { status: "operational", incidents: [], maintenance: [], affected_components: [], ... }
111
+ ```
112
+
105
113
  ## Writes and waiting
106
114
 
107
115
  Tools run with `waitForReadiness: true`. When a mutation response includes an `operations` array, the call waits until those operations finish. The default deadline is five minutes (`wait.timeoutMs`). Pass `wait: { timeoutMs: 30_000 }` on `createNeonTools` or `createNeonTool` to bound that. Set it below the host's own tool-call timeout, otherwise the host gives up first.