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

package/src/mcp-server/resources.ts

@@ -0,0 +1,158 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  McpServer,
+  ResourceMetadata,
+  ResourceTemplate,
+} from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { Variables } from "@modelcontextprotocol/sdk/shared/uriTemplate.js";
+import { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js";
+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 ReadResourceCallback = (
+  client: UnkeyCore,
+  uri: URL,
+  extra: RequestHandlerExtra,
+) => ReadResourceResult | Promise<ReadResourceResult>;
+
+export type ResourceDefinition = {
+  name: string;
+  description?: string;
+  metadata?: ResourceMetadata;
+  scopes?: MCPScope[];
+  resource: string;
+  read: ReadResourceCallback;
+};
+
+export type ReadResourceTemplateCallback = (
+  client: UnkeyCore,
+  uri: URL,
+  vars: Variables,
+  extra: RequestHandlerExtra,
+) => ReadResourceResult | Promise<ReadResourceResult>;
+
+export type ResourceTemplateDefinition = {
+  name: string;
+  description: string;
+  metadata?: ResourceMetadata;
+  scopes?: MCPScope[];
+  resource: ResourceTemplate;
+  read: ReadResourceTemplateCallback;
+};
+
+// Optional function to assist with formatting resource results
+export async function formatResult(
+  value: unknown,
+  uri: URL,
+  init: { mimeType?: string | undefined; response?: Response | undefined },
+): Promise<ReadResourceResult> {
+  if (typeof value === "undefined") {
+    return { contents: [] };
+  }
+
+  let contents: ReadResourceResult["contents"] = [];
+
+  const mimeType = init.mimeType ?? init.response?.headers.get("content-type")
+    ?? "";
+
+  if (mimeType.search(/\bjson\b/g) !== -1) {
+    contents = [{ uri: uri.toString(), mimeType, text: JSON.stringify(value) }];
+  } else if (
+    mimeType.startsWith("text/event-stream")
+    && isAsyncIterable(value)
+  ) {
+    contents = [
+      {
+        uri: uri.toString(),
+        mimeType: "application/json",
+        text: await stringifySSEToJSON(value),
+      },
+    ];
+  } else if (
+    (mimeType.startsWith("text/") || mimeType.startsWith("application/"))
+    && typeof value === "string"
+  ) {
+    contents = [{ uri: uri.toString(), mimeType, text: value }];
+  } else if (isBinaryData(value)) {
+    const blob = await valueToBase64(value);
+    contents = blob == null ? [] : [{ uri: uri.toString(), blob, mimeType }];
+  } else {
+    throw new Error(`Unsupported content type: "${mimeType}"`);
+  }
+
+  return { contents };
+}
+
+async function stringifySSEToJSON(
+  value: AsyncIterable<unknown>,
+): Promise<string> {
+  const payloads = [];
+
+  for await (const chunk of value) {
+    payloads.push(chunk);
+  }
+
+  return JSON.stringify(payloads);
+}
+
+export function createRegisterResource(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: UnkeyCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceDefinition) => void {
+  return (resource: ResourceDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, ctx) => resource.read(sdk, uri, ctx),
+    );
+
+    logger.debug("Registered resource", { name: resource.name });
+  };
+}
+
+export function createRegisterResourceTemplate(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: UnkeyCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceTemplateDefinition) => void {
+  return (resource: ResourceTemplateDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, vars, ctx) => resource.read(sdk, uri, vars, ctx),
+    );
+
+    logger.debug("Registered resource template", { name: resource.name });
+  };
+}

package/src/mcp-server/scopes.ts

@@ -0,0 +1,7 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export const mcpScopes = [] as const;
+
+export type MCPScope = (typeof mcpScopes)[number];

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/components/index.ts

@@ -2,7 +2,6 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export * from "./httpmetadata.js";
 export * from "./security.js";
 export * from "./v2livenessresponsebody.js";
 export * from "./v2ratelimitdeleteoverriderequestbody.js";

package/src/models/errors/apierror.ts

@@ -3,19 +3,25 @@
  */
 
 export class APIError extends Error {
+  public readonly statusCode: number;
+  public readonly contentType: string;
+
   constructor(
     message: string,
-    public readonly httpMeta: {
-      response: Response;
-      request: Request;
-    },
+    public readonly rawResponse: Response,
+    public readonly body: string = "",
   ) {
+    const statusCode = rawResponse.status;
+    const contentType = rawResponse.headers.get("content-type") || "";
+    const bodyString = body.length > 0 ? `\n${body}` : "";
+
     super(
-      `${message}: Status ${httpMeta.response.status} Content-Type ${
-        httpMeta.response.headers.get("content-type") || ""
-      }`,
+      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
     );
 
+    this.statusCode = statusCode;
+    this.contentType = contentType;
+
     this.name = "APIError";
   }
 }

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,