@unkey/api 2.0.0-alpha.1 → 2.0.0-alpha.5

package/src/mcp-server/server.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { UnkeyCore } from "../core.js";
+import { SDKOptions } from "../lib/config.js";
+import type { ConsoleLogger } from "./console-logger.js";
+import { createRegisterPrompt } from "./prompts.js";
+import {
+  createRegisterResource,
+  createRegisterResourceTemplate,
+} from "./resources.js";
+import { MCPScope, mcpScopes } from "./scopes.js";
+import { createRegisterTool } from "./tools.js";
+import { tool$livenessCheck } from "./tools/livenessCheck.js";
+import { tool$ratelimitDeleteOverride } from "./tools/ratelimitDeleteOverride.js";
+import { tool$ratelimitGetOverride } from "./tools/ratelimitGetOverride.js";
+import { tool$ratelimitLimit } from "./tools/ratelimitLimit.js";
+import { tool$ratelimitSetOverride } from "./tools/ratelimitSetOverride.js";
+
+export function createMCPServer(deps: {
+  logger: ConsoleLogger;
+  allowedTools?: string[] | undefined;
+  scopes?: MCPScope[] | undefined;
+  serverURL?: string | undefined;
+  rootKey?: SDKOptions["rootKey"] | undefined;
+  serverIdx?: SDKOptions["serverIdx"] | undefined;
+}) {
+  const server = new McpServer({
+    name: "Unkey",
+    version: "2.0.0-alpha.5",
+  });
+
+  const client = new UnkeyCore({
+    rootKey: deps.rootKey,
+    serverURL: deps.serverURL,
+    serverIdx: deps.serverIdx,
+  });
+
+  const scopes = new Set(deps.scopes ?? mcpScopes);
+
+  const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
+  const tool = createRegisterTool(
+    deps.logger,
+    server,
+    client,
+    scopes,
+    allowedTools,
+  );
+  const resource = createRegisterResource(deps.logger, server, client, scopes);
+  const resourceTemplate = createRegisterResourceTemplate(
+    deps.logger,
+    server,
+    client,
+    scopes,
+  );
+  const prompt = createRegisterPrompt(deps.logger, server, client, scopes);
+  const register = { tool, resource, resourceTemplate, prompt };
+  void register; // suppress unused warnings
+
+  tool(tool$ratelimitLimit);
+  tool(tool$ratelimitSetOverride);
+  tool(tool$ratelimitGetOverride);
+  tool(tool$ratelimitDeleteOverride);
+  tool(tool$livenessCheck);
+
+  return server;
+}

package/src/mcp-server/shared.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { bytesToBase64 } from "../lib/base64.js";
+
+type BinaryData =
+  | Uint8Array
+  | ArrayBuffer
+  | Blob
+  | ReadableStream
+  | Response
+  | string;
+
+export async function consumeStream(
+  stream: ReadableStream<Uint8Array>,
+): Promise<Uint8Array> {
+  const reader = stream.getReader();
+  const chunks: Uint8Array[] = [];
+
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (value != null) chunks.push(value);
+      if (done) break;
+    }
+  } finally {
+    reader.releaseLock();
+  }
+
+  return new Uint8Array(await new Blob(chunks).arrayBuffer());
+}
+
+export function isAsyncIterable(
+  value: unknown,
+): value is AsyncIterable<string> {
+  return (
+    typeof value === "object" && value != null && Symbol.asyncIterator in value
+  );
+}
+
+export function isBinaryData(value: unknown): value is BinaryData {
+  return (
+    value instanceof Uint8Array
+    || value instanceof ArrayBuffer
+    || value instanceof Blob
+    || value instanceof ReadableStream
+    || value instanceof Response
+    || typeof value === "string"
+  );
+}
+
+const base64Schema = z.string().base64();
+
+export async function valueToBase64(
+  value: BinaryData | null | undefined,
+): Promise<string | null> {
+  if (value == null) {
+    return null;
+  } else if (value instanceof Uint8Array) {
+    return bytesToBase64(value);
+  } else if (value instanceof ArrayBuffer) {
+    return bytesToBase64(new Uint8Array(value));
+  } else if (value instanceof Response || value instanceof Blob) {
+    return bytesToBase64(new Uint8Array(await value.arrayBuffer()));
+  } else if (value instanceof ReadableStream) {
+    return bytesToBase64(await consumeStream(value));
+  } else if (typeof value === "string") {
+    return base64Schema.parse(value);
+  } else {
+    value satisfies never;
+    throw new Error(`Unsupported image value type: ${typeof value}`);
+  }
+}

package/src/mcp-server/tools/livenessCheck.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { livenessCheck } from "../../funcs/livenessCheck.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+export const tool$livenessCheck: ToolDefinition = {
+  name: "liveness-check",
+  description: `Liveness check
+
+This endpoint checks if the service is alive.`,
+  tool: async (client, ctx) => {
+    const [result, apiCall] = await livenessCheck(
+      client,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/ratelimitDeleteOverride.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ratelimitDeleteOverride } from "../../funcs/ratelimitDeleteOverride.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.V2RatelimitDeleteOverrideRequestBody$inboundSchema,
+};
+
+export const tool$ratelimitDeleteOverride: ToolDefinition<typeof args> = {
+  name: "ratelimit-delete-override",
+  description: ``,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ratelimitDeleteOverride(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/ratelimitGetOverride.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ratelimitGetOverride } from "../../funcs/ratelimitGetOverride.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.V2RatelimitGetOverrideRequestBody$inboundSchema,
+};
+
+export const tool$ratelimitGetOverride: ToolDefinition<typeof args> = {
+  name: "ratelimit-get-override",
+  description: ``,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ratelimitGetOverride(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/ratelimitLimit.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ratelimitLimit } from "../../funcs/ratelimitLimit.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.V2RatelimitLimitRequestBody$inboundSchema,
+};
+
+export const tool$ratelimitLimit: ToolDefinition<typeof args> = {
+  name: "ratelimit-limit",
+  description: `TODO`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ratelimitLimit(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/ratelimitSetOverride.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ratelimitSetOverride } from "../../funcs/ratelimitSetOverride.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.V2RatelimitSetOverrideRequestBody$inboundSchema,
+};
+
+export const tool$ratelimitSetOverride: ToolDefinition<typeof args> = {
+  name: "ratelimit-set-override",
+  description: ``,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ratelimitSetOverride(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { objectOutputType, ZodRawShape, ZodTypeAny } from "zod";
+import { UnkeyCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
+
+export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
+  Args extends ZodRawShape ? {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args: Args;
+      tool: (
+        client: UnkeyCore,
+        args: objectOutputType<Args, ZodTypeAny>,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    }
+    : {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args?: undefined;
+      tool: (
+        client: UnkeyCore,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    };
+
+// Optional function to assist with formatting tool results
+export async function formatResult(
+  value: unknown,
+  init: { response?: Response | undefined },
+): Promise<CallToolResult> {
+  if (typeof value === "undefined") {
+    return { content: [] };
+  }
+
+  const { response } = init;
+  const contentType = response?.headers.get("content-type") ?? "";
+  let content: CallToolResult["content"] = [];
+
+  if (contentType.search(/\bjson\b/g)) {
+    content = [{ type: "text", text: JSON.stringify(value) }];
+  } else if (
+    contentType.startsWith("text/event-stream")
+    && isAsyncIterable(value)
+  ) {
+    content = await consumeSSE(value);
+  } else if (contentType.startsWith("text/") && typeof value === "string") {
+    content = [{ type: "text", text: value }];
+  } else if (isBinaryData(value) && contentType.startsWith("image/")) {
+    const data = await valueToBase64(value);
+    content = data == null
+      ? []
+      : [{ type: "image", data, mimeType: contentType }];
+  } else {
+    return {
+      content: [{
+        type: "text",
+        text: `Unsupported content type: "${contentType}"`,
+      }],
+      isError: true,
+    };
+  }
+
+  return { content };
+}
+
+async function consumeSSE(
+  value: AsyncIterable<unknown>,
+): Promise<CallToolResult["content"]> {
+  const content: CallToolResult["content"] = [];
+
+  for await (const chunk of value) {
+    if (typeof chunk === "string") {
+      content.push({ type: "text", text: chunk });
+    } else {
+      content.push({ type: "text", text: JSON.stringify(chunk) });
+    }
+  }
+
+  return content;
+}
+
+export function createRegisterTool(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: UnkeyCore,
+  allowedScopes: Set<MCPScope>,
+  allowedTools?: Set<string>,
+): <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>) => void {
+  return <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>): void => {
+    if (allowedTools && !allowedTools.has(tool.name)) {
+      return;
+    }
+
+    const toolScopes = tool.scopes ?? [];
+    if (allowedScopes.size > 0 && toolScopes.length === 0) {
+      return;
+    }
+
+    if (!toolScopes.every((s) => allowedScopes.has(s))) {
+      return;
+    }
+
+    if (tool.args) {
+      server.tool(tool.name, tool.description, tool.args, async (args, ctx) => {
+        return tool.tool(sdk, args, ctx);
+      });
+    } else {
+      server.tool(tool.name, tool.description, async (ctx) => {
+        return tool.tool(sdk, ctx);
+      });
+    }
+
+    logger.debug("Registered tool", { name: tool.name });
+  };
+}

package/src/models/errors/{notfounderror.ts → baseerror.ts}

@@ -4,7 +4,7 @@
 
 import * as z from "zod";
 
-export type NotFoundErrorData = {
+export type BaseErrorData = {
   /**
    * A unique id for this request. Please always provide this to support.
    */
@@ -31,7 +31,7 @@ export type NotFoundErrorData = {
   type: string;
 };
 
-export class NotFoundError extends Error {
+export class BaseError extends Error {
   /**
    * A unique id for this request. Please always provide this to support.
    */
@@ -58,9 +58,9 @@ export class NotFoundError extends Error {
   type: string;
 
   /** The original data that was passed to this error instance. */
-  data$: NotFoundErrorData;
+  data$: BaseErrorData;
 
-  constructor(err: NotFoundErrorData) {
+  constructor(err: BaseErrorData) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
@@ -74,13 +74,13 @@ export class NotFoundError extends Error {
     this.title = err.title;
     this.type = err.type;
 
-    this.name = "NotFoundError";
+    this.name = "BaseError";
   }
 }
 
 /** @internal */
-export const NotFoundError$inboundSchema: z.ZodType<
-  NotFoundError,
+export const BaseError$inboundSchema: z.ZodType<
+  BaseError,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -92,11 +92,11 @@ export const NotFoundError$inboundSchema: z.ZodType<
   type: z.string(),
 })
   .transform((v) => {
-    return new NotFoundError(v);
+    return new BaseError(v);
   });
 
 /** @internal */
-export type NotFoundError$Outbound = {
+export type BaseError$Outbound = {
   requestId: string;
   detail: string;
   instance?: string | undefined;
@@ -106,11 +106,11 @@ export type NotFoundError$Outbound = {
 };
 
 /** @internal */
-export const NotFoundError$outboundSchema: z.ZodType<
-  NotFoundError$Outbound,
+export const BaseError$outboundSchema: z.ZodType<
+  BaseError$Outbound,
   z.ZodTypeDef,
-  NotFoundError
-> = z.instanceof(NotFoundError)
+  BaseError
+> = z.instanceof(BaseError)
   .transform(v => v.data$)
   .pipe(z.object({
     requestId: z.string(),
@@ -125,11 +125,11 @@ export const NotFoundError$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace NotFoundError$ {
-  /** @deprecated use `NotFoundError$inboundSchema` instead. */
-  export const inboundSchema = NotFoundError$inboundSchema;
-  /** @deprecated use `NotFoundError$outboundSchema` instead. */
-  export const outboundSchema = NotFoundError$outboundSchema;
-  /** @deprecated use `NotFoundError$Outbound` instead. */
-  export type Outbound = NotFoundError$Outbound;
+export namespace BaseError$ {
+  /** @deprecated use `BaseError$inboundSchema` instead. */
+  export const inboundSchema = BaseError$inboundSchema;
+  /** @deprecated use `BaseError$outboundSchema` instead. */
+  export const outboundSchema = BaseError$outboundSchema;
+  /** @deprecated use `BaseError$Outbound` instead. */
+  export type Outbound = BaseError$Outbound;
 }

package/src/models/errors/index.ts

@@ -4,10 +4,6 @@
 
 export * from "./apierror.js";
 export * from "./badrequesterror.js";
-export * from "./forbiddenerror.js";
+export * from "./baseerror.js";
 export * from "./httpclienterrors.js";
-export * from "./internalservererror.js";
-export * from "./notfounderror.js";
-export * from "./preconditionfailederror.js";
 export * from "./sdkvalidationerror.js";
-export * from "./unauthorizederror.js";

package/src/sdk/liveness.ts

@@ -4,7 +4,7 @@
 
 import { livenessCheck } from "../funcs/livenessCheck.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as operations from "../models/operations/index.js";
+import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Liveness extends ClientSDK {
@@ -16,7 +16,7 @@ export class Liveness extends ClientSDK {
    */
   async check(
     options?: RequestOptions,
-  ): Promise<operations.LivenessResponse> {
+  ): Promise<components.V2LivenessResponseBody> {
     return unwrapAsync(livenessCheck(
       this,
       options,

package/src/sdk/ratelimit.ts

@@ -8,7 +8,6 @@ import { ratelimitLimit } from "../funcs/ratelimitLimit.js";
 import { ratelimitSetOverride } from "../funcs/ratelimitSetOverride.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
-import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Ratelimit extends ClientSDK {
@@ -18,7 +17,7 @@ export class Ratelimit extends ClientSDK {
   async limit(
     request: components.V2RatelimitLimitRequestBody,
     options?: RequestOptions,
-  ): Promise<operations.V1RatelimitLimitResponse> {
+  ): Promise<components.V2RatelimitLimitResponseBody> {
     return unwrapAsync(ratelimitLimit(
       this,
       request,
@@ -29,7 +28,7 @@ export class Ratelimit extends ClientSDK {
   async setOverride(
     request: components.V2RatelimitSetOverrideRequestBody,
     options?: RequestOptions,
-  ): Promise<operations.RatelimitSetOverrideResponse> {
+  ): Promise<components.V2RatelimitSetOverrideResponseBody> {
     return unwrapAsync(ratelimitSetOverride(
       this,
       request,
@@ -40,7 +39,7 @@ export class Ratelimit extends ClientSDK {
   async getOverride(
     request: components.V2RatelimitGetOverrideRequestBody,
     options?: RequestOptions,
-  ): Promise<operations.RatelimitGetOverrideResponse> {
+  ): Promise<components.V2RatelimitGetOverrideResponseBody> {
     return unwrapAsync(ratelimitGetOverride(
       this,
       request,
@@ -51,7 +50,7 @@ export class Ratelimit extends ClientSDK {
   async deleteOverride(
     request: components.V2RatelimitDeleteOverrideRequestBody,
     options?: RequestOptions,
-  ): Promise<operations.RatelimitDeleteOverrideResponse> {
+  ): Promise<components.V2RatelimitDeleteOverrideResponseBody> {
     return unwrapAsync(ratelimitDeleteOverride(
       this,
       request,