@orq-ai/node 3.1.9 → 3.1.11

package/src/mcp-server/resources.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { 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 { OrqCore } from "../core.js";
+import { Result } from "../types/fp.js";
+import { MCPScope } from "./scopes.js";
+import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
+
+export type ReadResourceCallback = (
+  client: OrqCore,
+  uri: URL,
+  extra: RequestHandlerExtra,
+) => ReadResourceResult | Promise<ReadResourceResult>;
+
+export type ResourceDefinition = {
+  name: string;
+  description: string;
+  scopes?: MCPScope[];
+  resource: string;
+  read: ReadResourceCallback;
+};
+
+export type ReadResourceTemplateCallback = (
+  client: OrqCore,
+  uri: URL,
+  vars: Variables,
+  extra: RequestHandlerExtra,
+) => ReadResourceResult | Promise<ReadResourceResult>;
+
+export type ResourceTemplateDefinition = {
+  name: string;
+  description: string;
+  scopes?: MCPScope[];
+  resource: ResourceTemplate;
+  read: ReadResourceTemplateCallback;
+};
+
+export async function formatResult(
+  result: Result<unknown, Error>,
+  uri: URL,
+  init: { response?: Response | undefined },
+): Promise<ReadResourceResult> {
+  if (!result.ok) {
+    throw result.error;
+  }
+
+  const { value } = result;
+  if (typeof value === "undefined") {
+    return { contents: [] };
+  }
+
+  const { response } = init;
+  const mimeType = response?.headers.get("content-type") ?? "";
+  let contents: ReadResourceResult["contents"] = [];
+
+  if (mimeType.search(/\bjson\b/g)) {
+    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/") && 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);
+}

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,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { OrqCore } from "../core.js";
+import { SDKOptions } from "../lib/config.js";
+import type { ConsoleLogger } from "./console-logger.js";
+import { MCPScope, mcpScopes } from "./scopes.js";
+import { createRegisterTool } from "./tools.js";
+import { tool$contactsCreate } from "./tools/contactsCreate.js";
+import { tool$deploymentsGetConfig } from "./tools/deploymentsGetConfig.js";
+import { tool$deploymentsInvoke } from "./tools/deploymentsInvoke.js";
+import { tool$deploymentsList } from "./tools/deploymentsList.js";
+import { tool$deploymentsMetricsCreate } from "./tools/deploymentsMetricsCreate.js";
+import { tool$deploymentsStream } from "./tools/deploymentsStream.js";
+import { tool$feedbackCreate } from "./tools/feedbackCreate.js";
+import { tool$filesCreate } from "./tools/filesCreate.js";
+import { tool$filesDelete } from "./tools/filesDelete.js";
+import { tool$filesGet } from "./tools/filesGet.js";
+import { tool$filesList } from "./tools/filesList.js";
+import { tool$promptsCreate } from "./tools/promptsCreate.js";
+import { tool$promptsDelete } from "./tools/promptsDelete.js";
+import { tool$promptsGetVersion } from "./tools/promptsGetVersion.js";
+import { tool$promptsList } from "./tools/promptsList.js";
+import { tool$promptsListVersions } from "./tools/promptsListVersions.js";
+import { tool$promptsRetrieve } from "./tools/promptsRetrieve.js";
+import { tool$promptsUpdate } from "./tools/promptsUpdate.js";
+import { tool$remoteconfigsRetrieve } from "./tools/remoteconfigsRetrieve.js";
+
+export function createMCPServer(deps: {
+  logger: ConsoleLogger;
+  allowedTools?: string[] | undefined;
+  scopes?: MCPScope[] | undefined;
+  serverURL?: string | undefined;
+  apiKey?: SDKOptions["apiKey"] | undefined;
+  contactId?: SDKOptions["contactId"] | undefined;
+  environment?: SDKOptions["environment"] | undefined;
+  serverIdx?: SDKOptions["serverIdx"] | undefined;
+}) {
+  const server = new McpServer({
+    name: "Orq",
+    version: "3.1.11",
+  });
+
+  const client = new OrqCore({
+    apiKey: deps.apiKey,
+    contactId: deps.contactId,
+    environment: deps.environment,
+    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,
+  );
+
+  tool(tool$contactsCreate);
+  tool(tool$feedbackCreate);
+  tool(tool$deploymentsList);
+  tool(tool$deploymentsGetConfig);
+  tool(tool$deploymentsInvoke);
+  tool(tool$deploymentsStream);
+  tool(tool$filesCreate);
+  tool(tool$filesList);
+  tool(tool$filesGet);
+  tool(tool$filesDelete);
+  tool(tool$promptsList);
+  tool(tool$promptsCreate);
+  tool(tool$promptsRetrieve);
+  tool(tool$promptsUpdate);
+  tool(tool$promptsDelete);
+  tool(tool$promptsListVersions);
+  tool(tool$promptsGetVersion);
+  tool(tool$remoteconfigsRetrieve);
+  tool(tool$deploymentsMetricsCreate);
+
+  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/contactsCreate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsCreate } from "../../funcs/contactsCreate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.CreateContactRequestBody$inboundSchema,
+};
+
+export const tool$contactsCreate: ToolDefinition<typeof args> = {
+  name: "contacts_create",
+  description: `Update user information
+
+Update or add user information to workspace`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await contactsCreate(
+      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/deploymentsGetConfig.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsGetConfig } from "../../funcs/deploymentsGetConfig.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DeploymentGetConfigRequestBody$inboundSchema,
+};
+
+export const tool$deploymentsGetConfig: ToolDefinition<typeof args> = {
+  name: "deployments_get-config",
+  description: `Get config
+
+Retrieve the deployment configuration`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await deploymentsGetConfig(
+      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/deploymentsInvoke.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsInvoke } from "../../funcs/deploymentsInvoke.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.Deployments$inboundSchema,
+};
+
+export const tool$deploymentsInvoke: ToolDefinition<typeof args> = {
+  name: "deployments_invoke",
+  description: `Invoke
+
+Invoke a deployment with a given payload`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await deploymentsInvoke(
+      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/deploymentsList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsList } from "../../funcs/deploymentsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DeploymentsRequest$inboundSchema.optional(),
+};
+
+export const tool$deploymentsList: ToolDefinition<typeof args> = {
+  name: "deployments_list",
+  description: `List all deployments
+
+Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await deploymentsList(
+      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/deploymentsMetricsCreate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsMetricsCreate } from "../../funcs/deploymentsMetricsCreate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DeploymentCreateMetricRequest$inboundSchema,
+};
+
+export const tool$deploymentsMetricsCreate: ToolDefinition<typeof args> = {
+  name: "deployments-metrics_create",
+  description: `Add metrics
+
+Add metrics to a deployment`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await deploymentsMetricsCreate(
+      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/deploymentsStream.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsStream } from "../../funcs/deploymentsStream.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DeploymentStreamRequestBody$inboundSchema,
+};
+
+export const tool$deploymentsStream: ToolDefinition<typeof args> = {
+  name: "deployments_stream",
+  description: `Stream
+
+Stream deployment generation. Only supported for completions and chat completions.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await deploymentsStream(
+      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/feedbackCreate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { feedbackCreate } from "../../funcs/feedbackCreate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.CreateFeedbackRequestBody$inboundSchema,
+};
+
+export const tool$feedbackCreate: ToolDefinition<typeof args> = {
+  name: "feedback_create",
+  description: `Submit feedback
+
+Submit feedback for the LLM transaction via the API`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await feedbackCreate(
+      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/filesCreate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { filesCreate } from "../../funcs/filesCreate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FileUploadRequestBody$inboundSchema.optional(),
+};
+
+export const tool$filesCreate: ToolDefinition<typeof args> = {
+  name: "files_create",
+  description: `Create file
+
+Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await filesCreate(
+      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/filesDelete.ts

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

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { filesGet } from "../../funcs/filesGet.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FileGetRequest$inboundSchema,
+};
+
+export const tool$filesGet: ToolDefinition<typeof args> = {
+  name: "files_get",
+  description: `Retrieve a file
+
+Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await filesGet(
+      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/filesList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { filesList } from "../../funcs/filesList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FileListRequest$inboundSchema.optional(),
+};
+
+export const tool$filesList: ToolDefinition<typeof args> = {
+  name: "files_list",
+  description: `List all files
+
+Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await filesList(
+      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);
+  },
+};