@unkey/api 2.0.0-alpha.2 → 2.0.0-alpha.6

package/FUNCTIONS.md

@@ -32,9 +32,9 @@ const unkey = new UnkeyCore({
 async function run() {
   const res = await ratelimitLimit(unkey, {
     namespace: "sms.sign_up",
-    duration: 455106,
+    duration: 711276,
     identifier: "<value>",
-    limit: 568662,
+    limit: 581877,
   });
 
   switch (true) {

package/README.md

@@ -75,6 +75,90 @@ yarn add @unkey/api zod
 
 > [!NOTE]
 > This package is published with CommonJS and ES Modules (ESM) support.
+
+
+### Model Context Protocol (MCP) Server
+
+This SDK is also an installable MCP server where the various SDK methods are
+exposed as tools that can be invoked by AI applications.
+
+> Node.js v20 or greater is required to run the MCP server from npm.
+
+<details>
+<summary>Claude installation steps</summary>
+
+Add the following server definition to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "Unkey": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@unkey/api",
+        "--",
+        "mcp", "start",
+        "--root-key", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Cursor installation steps</summary>
+
+Create a `.cursor/mcp.json` file in your project root with the following content:
+
+```json
+{
+  "mcpServers": {
+    "Unkey": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@unkey/api",
+        "--",
+        "mcp", "start",
+        "--root-key", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
+
+```bash
+curl -L -o mcp-server \
+    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
+chmod +x mcp-server
+```
+
+If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
+
+
+```json
+{
+  "mcpServers": {
+    "Todos": {
+      "command": "./DOWNLOAD/PATH/mcp-server",
+      "args": [
+        "start"
+      ]
+    }
+  }
+}
+```
+
+For a full list of server arguments, run:
+
+```sh
+npx -y --package @unkey/api -- mcp start --help
+```
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -98,9 +182,9 @@ const unkey = new Unkey({
 async function run() {
   const result = await unkey.ratelimit.limit({
     namespace: "sms.sign_up",
-    duration: 455106,
+    duration: 711276,
     identifier: "<value>",
-    limit: 568662,
+    limit: 581877,
   });
 
   // Handle the result
@@ -134,9 +218,9 @@ const unkey = new Unkey({
 async function run() {
   const result = await unkey.ratelimit.limit({
     namespace: "sms.sign_up",
-    duration: 455106,
+    duration: 711276,
     identifier: "<value>",
-    limit: 568662,
+    limit: 581877,
   });
 
   // Handle the result
@@ -154,6 +238,14 @@ run();
 <details open>
 <summary>Available methods</summary>
 
+### [apis](docs/sdks/apis/README.md)
+
+* [createApi](docs/sdks/apis/README.md#createapi)
+
+### [identities](docs/sdks/identities/README.md)
+
+* [v2IdentitiesCreateIdentity](docs/sdks/identities/README.md#v2identitiescreateidentity)
+
 ### [liveness](docs/sdks/liveness/README.md)
 
 * [check](docs/sdks/liveness/README.md#check) - Liveness check
@@ -163,6 +255,7 @@ run();
 * [limit](docs/sdks/ratelimit/README.md#limit) - TODO
 * [setOverride](docs/sdks/ratelimit/README.md#setoverride)
 * [getOverride](docs/sdks/ratelimit/README.md#getoverride)
+* [ratelimitListOverrides](docs/sdks/ratelimit/README.md#ratelimitlistoverrides) - List rate limit overrides
 * [deleteOverride](docs/sdks/ratelimit/README.md#deleteoverride)
 
 
@@ -184,10 +277,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
+- [`apisCreateApi`](docs/sdks/apis/README.md#createapi)
+- [`identitiesV2IdentitiesCreateIdentity`](docs/sdks/identities/README.md#v2identitiescreateidentity)
 - [`livenessCheck`](docs/sdks/liveness/README.md#check) - Liveness check
 - [`ratelimitDeleteOverride`](docs/sdks/ratelimit/README.md#deleteoverride)
 - [`ratelimitGetOverride`](docs/sdks/ratelimit/README.md#getoverride)
 - [`ratelimitLimit`](docs/sdks/ratelimit/README.md#limit) - TODO
+- [`ratelimitRatelimitListOverrides`](docs/sdks/ratelimit/README.md#ratelimitlistoverrides) - List rate limit overrides
 - [`ratelimitSetOverride`](docs/sdks/ratelimit/README.md#setoverride)
 
 </details>
@@ -209,9 +305,9 @@ const unkey = new Unkey({
 async function run() {
   const result = await unkey.ratelimit.limit({
     namespace: "sms.sign_up",
-    duration: 455106,
+    duration: 711276,
     identifier: "<value>",
-    limit: 568662,
+    limit: 581877,
   }, {
     retries: {
       strategy: "backoff",
@@ -254,9 +350,9 @@ const unkey = new Unkey({
 async function run() {
   const result = await unkey.ratelimit.limit({
     namespace: "sms.sign_up",
-    duration: 455106,
+    duration: 711276,
     identifier: "<value>",
-    limit: 568662,
+    limit: 581877,
   });
 
   // Handle the result
@@ -273,21 +369,26 @@ run();
 
 Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `limit` method may throw the following errors:
 
-| Error Type             | Status Code   | Content Type             |
-| ---------------------- | ------------- | ------------------------ |
-| errors.BadRequestError | 400           | application/problem+json |
-| errors.BaseError       | 401, 403, 404 | application/problem+json |
-| errors.BaseError       | 500           | application/problem+json |
-| errors.APIError        | 4XX, 5XX      | \*/\*                    |
+| Error Type                         | Status Code | Content Type     |
+| ---------------------------------- | ----------- | ---------------- |
+| errors.BadRequestErrorResponse     | 400         | application/json |
+| errors.UnauthorizedErrorResponse   | 401         | application/json |
+| errors.ForbiddenErrorResponse      | 403         | application/json |
+| errors.NotFoundErrorResponse       | 404         | application/json |
+| errors.InternalServerErrorResponse | 500         | application/json |
+| errors.APIError                    | 4XX, 5XX    | \*/\*            |
 
 If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
 
 ```typescript
 import { Unkey } from "@unkey/api";
 import {
-  BadRequestError,
-  BaseError,
+  BadRequestErrorResponse,
+  ForbiddenErrorResponse,
+  InternalServerErrorResponse,
+  NotFoundErrorResponse,
   SDKValidationError,
+  UnauthorizedErrorResponse,
 } from "@unkey/api/models/errors";
 
 const unkey = new Unkey({
@@ -299,9 +400,9 @@ async function run() {
   try {
     result = await unkey.ratelimit.limit({
       namespace: "sms.sign_up",
-      duration: 455106,
+      duration: 711276,
       identifier: "<value>",
-      limit: 568662,
+      limit: 581877,
     });
 
     // Handle the result
@@ -316,18 +417,28 @@ async function run() {
         console.error(err.rawValue);
         return;
       }
-      case (err instanceof BadRequestError): {
-        // Handle err.data$: BadRequestErrorData
+      case (err instanceof BadRequestErrorResponse): {
+        // Handle err.data$: BadRequestErrorResponseData
+        console.error(err);
+        return;
+      }
+      case (err instanceof UnauthorizedErrorResponse): {
+        // Handle err.data$: UnauthorizedErrorResponseData
+        console.error(err);
+        return;
+      }
+      case (err instanceof ForbiddenErrorResponse): {
+        // Handle err.data$: ForbiddenErrorResponseData
         console.error(err);
         return;
       }
-      case (err instanceof BaseError): {
-        // Handle err.data$: BaseErrorData
+      case (err instanceof NotFoundErrorResponse): {
+        // Handle err.data$: NotFoundErrorResponseData
         console.error(err);
         return;
       }
-      case (err instanceof BaseError): {
-        // Handle err.data$: BaseErrorData
+      case (err instanceof InternalServerErrorResponse): {
+        // Handle err.data$: InternalServerErrorResponseData
         console.error(err);
         return;
       }
@@ -373,9 +484,9 @@ const unkey = new Unkey({
 async function run() {
   const result = await unkey.ratelimit.limit({
     namespace: "sms.sign_up",
-    duration: 455106,
+    duration: 711276,
     identifier: "<value>",
-    limit: 568662,
+    limit: 581877,
   });
 
   // Handle the result