@orq-ai/node 3.1.9 → 3.1.10

package/packages/orq-rc/src/mcp-server/cli/start/impl.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SSEServerTransport } from "@modelcontextprotocol/sdk/server/sse.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import express from "express";
+import { SDKOptions } from "../../../lib/config.js";
+import { LocalContext } from "../../cli.js";
+import {
+  ConsoleLoggerLevel,
+  createConsoleLogger,
+} from "../../console-logger.js";
+import { MCPScope } from "../../scopes.js";
+import { createMCPServer } from "../../server.js";
+
+interface StartCommandFlags {
+  readonly transport: "stdio" | "sse";
+  readonly port: number;
+  readonly scope?: MCPScope[];
+  readonly "api-key"?: string | undefined;
+  readonly "contact-id"?: SDKOptions["contactId"] | undefined;
+  readonly environment?: SDKOptions["environment"] | undefined;
+  readonly "server-url"?: string;
+  readonly "server-index"?: SDKOptions["serverIdx"];
+  readonly "log-level": ConsoleLoggerLevel;
+  readonly env?: [string, string][];
+}
+
+export async function main(this: LocalContext, flags: StartCommandFlags) {
+  flags.env?.forEach(([key, value]) => {
+    process.env[key] = value;
+  });
+
+  switch (flags.transport) {
+    case "stdio":
+      await startStdio(flags);
+      break;
+    case "sse":
+      await startSSE(flags);
+      break;
+    default:
+      throw new Error(`Invalid transport: ${flags.transport}`);
+  }
+}
+
+async function startStdio(flags: StartCommandFlags) {
+  const logger = createConsoleLogger(flags["log-level"]);
+  const transport = new StdioServerTransport();
+  const server = createMCPServer({
+    logger,
+    scopes: flags.scope,
+    ...{ apiKey: flags["api-key"] },
+    contactId: flags["contact-id"],
+    environment: flags.environment,
+    serverURL: flags["server-url"],
+    serverIdx: flags["server-index"],
+  });
+  await server.connect(transport);
+
+  const abort = async () => {
+    await server.close();
+    process.exit(0);
+  };
+  process.on("SIGTERM", abort);
+  process.on("SIGINT", abort);
+}
+
+async function startSSE(flags: StartCommandFlags) {
+  const logger = createConsoleLogger(flags["log-level"]);
+  const app = express();
+  const mcpServer = createMCPServer({
+    logger,
+    scopes: flags.scope,
+    ...{ apiKey: flags["api-key"] },
+    contactId: flags["contact-id"],
+    environment: flags.environment,
+    serverURL: flags["server-url"],
+    serverIdx: flags["server-index"],
+  });
+  let transport: SSEServerTransport | undefined;
+  const controller = new AbortController();
+
+  app.get("/sse", async (_req, res) => {
+    transport = new SSEServerTransport("/message", res);
+
+    await mcpServer.connect(transport);
+
+    mcpServer.server.onclose = async () => {
+      res.end();
+    };
+  });
+
+  app.post("/message", async (req, res) => {
+    if (!transport) {
+      throw new Error("Server transport not initialized");
+    }
+
+    await transport.handlePostMessage(req, res);
+  });
+
+  const httpServer = app.listen(flags.port, "0.0.0.0", () => {
+    const ha = httpServer.address();
+    const host = typeof ha === "string" ? ha : `${ha?.address}:${ha?.port}`;
+    logger.info("MCP HTTP server started", { host });
+  });
+
+  let closing = false;
+  controller.signal.addEventListener("abort", async () => {
+    if (closing) {
+      logger.info("Received second signal. Forcing shutdown.");
+      process.exit(1);
+    }
+    closing = true;
+
+    logger.info("Shutting down MCP server");
+
+    await mcpServer.close();
+
+    logger.info("Shutting down HTTP server");
+
+    const timer = setTimeout(() => {
+      logger.info("Forcing shutdown");
+      process.exit(1);
+    }, 5000);
+
+    httpServer.close(() => {
+      clearTimeout(timer);
+      logger.info("Graceful shutdown complete");
+      process.exit(0);
+    });
+  });
+
+  const abort = () => controller.abort();
+  process.on("SIGTERM", abort);
+  process.on("SIGINT", abort);
+}

package/packages/orq-rc/src/mcp-server/cli.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CommandContext, StricliProcess } from "@stricli/core";
+
+export interface LocalContext extends CommandContext {
+  readonly process: StricliProcess;
+}
+
+export function buildContext(process: NodeJS.Process): LocalContext {
+  return { process: process as StricliProcess };
+}

package/packages/orq-rc/src/mcp-server/console-logger.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export const consoleLoggerLevels = [
+  "debug",
+  "warning",
+  "info",
+  "error",
+] as const;
+
+export type ConsoleLoggerLevel = (typeof consoleLoggerLevels)[number];
+
+export type ConsoleLogger = {
+  [key in ConsoleLoggerLevel]: (
+    message: string,
+    data?: Record<string, unknown>,
+  ) => void;
+};
+
+export function createConsoleLogger(level: ConsoleLoggerLevel): ConsoleLogger {
+  const min = consoleLoggerLevels.indexOf(level);
+  const noop = () => {};
+
+  const logger: ConsoleLogger = {
+    debug: noop,
+    warning: noop,
+    info: noop,
+    error: noop,
+  };
+
+  return consoleLoggerLevels.reduce((logger, level, i) => {
+    if (i < min) {
+      return logger;
+    }
+
+    logger[level] = log.bind(null, level);
+
+    return logger;
+  }, logger);
+}
+
+function log(
+  level: ConsoleLoggerLevel,
+  message: string,
+  data?: Record<string, unknown>,
+) {
+  let line = "";
+  const allData = [{ msg: message, l: level }, data];
+
+  for (const ctx of allData) {
+    for (const [key, value] of Object.entries(ctx || {})) {
+      if (value == null) {
+        line += ` ${key}=<${value}>`;
+      } else if (typeof value === "function") {
+        line += ` ${key}=<function>`;
+      } else if (typeof value === "symbol") {
+        line += ` ${key}=${value.toString()}`;
+      } else if (typeof value === "string") {
+        const v = value.search(/\s/g) >= 0 ? JSON.stringify(value) : value;
+        line += ` ${key}=${v}`;
+      } else if (typeof value !== "object") {
+        line += ` ${key}=${value}`;
+      } else {
+        line += ` ${key}="${JSON.stringify(value)}"`;
+      }
+    }
+  }
+
+  console.error(line);
+}

package/packages/orq-rc/src/mcp-server/mcp-server.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { buildApplication, buildRouteMap, run } from "@stricli/core";
+import process from "node:process";
+import { buildContext } from "./cli.js";
+import { startCommand } from "./cli/start/command.js";
+
+const routes = buildRouteMap({
+  routes: {
+    start: startCommand,
+  },
+  docs: {
+    brief: "MCP server CLI",
+  },
+});
+
+export const app = buildApplication(routes, {
+  name: "mcp",
+  versionInfo: {
+    currentVersion: "3.2.0-rc.21",
+  },
+});
+
+run(app, process.argv.slice(2), buildContext(process));

package/packages/orq-rc/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/packages/orq-rc/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/packages/orq-rc/src/mcp-server/server.ts

@@ -0,0 +1,98 @@
+/*
+ * 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$datasetsClear } from "./tools/datasetsClear.js";
+import { tool$datasetsCreate } from "./tools/datasetsCreate.js";
+import { tool$datasetsCreateDatapoint } from "./tools/datasetsCreateDatapoint.js";
+import { tool$datasetsCreateDatapoints } from "./tools/datasetsCreateDatapoints.js";
+import { tool$datasetsDelete } from "./tools/datasetsDelete.js";
+import { tool$datasetsDeleteDatapoint } from "./tools/datasetsDeleteDatapoint.js";
+import { tool$datasetsList } from "./tools/datasetsList.js";
+import { tool$datasetsListDatapoints } from "./tools/datasetsListDatapoints.js";
+import { tool$datasetsRetrieve } from "./tools/datasetsRetrieve.js";
+import { tool$datasetsRetrieveDatapoint } from "./tools/datasetsRetrieveDatapoint.js";
+import { tool$datasetsUpdate } from "./tools/datasetsUpdate.js";
+import { tool$datasetsUpdateDatapoint } from "./tools/datasetsUpdateDatapoint.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$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;
+  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.2.0-rc.21",
+  });
+
+  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 tool = createRegisterTool(deps.logger, server, client, scopes);
+
+  tool(tool$contactsCreate);
+  tool(tool$feedbackCreate);
+  tool(tool$deploymentsList);
+  tool(tool$deploymentsGetConfig);
+  tool(tool$deploymentsInvoke);
+  tool(tool$filesCreate);
+  tool(tool$filesList);
+  tool(tool$filesGet);
+  tool(tool$filesDelete);
+  tool(tool$promptsList);
+  tool(tool$promptsRetrieve);
+  tool(tool$promptsUpdate);
+  tool(tool$promptsDelete);
+  tool(tool$promptsCreate);
+  tool(tool$promptsListVersions);
+  tool(tool$promptsGetVersion);
+  tool(tool$remoteconfigsRetrieve);
+  tool(tool$datasetsList);
+  tool(tool$datasetsCreate);
+  tool(tool$datasetsRetrieve);
+  tool(tool$datasetsUpdate);
+  tool(tool$datasetsDelete);
+  tool(tool$datasetsListDatapoints);
+  tool(tool$datasetsCreateDatapoint);
+  tool(tool$datasetsRetrieveDatapoint);
+  tool(tool$datasetsUpdateDatapoint);
+  tool(tool$datasetsDeleteDatapoint);
+  tool(tool$datasetsCreateDatapoints);
+  tool(tool$datasetsClear);
+  tool(tool$deploymentsMetricsCreate);
+
+  return server;
+}

package/packages/orq-rc/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/packages/orq-rc/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/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { datasetsClear } from "../../funcs/datasetsClear.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ClearDatasetRequest$inboundSchema,
+};
+
+export const tool$datasetsClear: ToolDefinition<typeof args> = {
+  name: "datasets_clear",
+  description: `Delete all datapoints
+
+Delete all datapoints from a dataset. This action is irreversible.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await datasetsClear(
+      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/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { datasetsCreate } from "../../funcs/datasetsCreate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.CreateDatasetRequestBody$inboundSchema.optional(),
+};
+
+export const tool$datasetsCreate: ToolDefinition<typeof args> = {
+  name: "datasets_create",
+  description: `Create a dataset
+
+Creates a new dataset in the specified project.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await datasetsCreate(
+      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/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { datasetsCreateDatapoint } from "../../funcs/datasetsCreateDatapoint.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.CreateDatasetItemRequest$inboundSchema,
+};
+
+export const tool$datasetsCreateDatapoint: ToolDefinition<typeof args> = {
+  name: "datasets_create-datapoint",
+  description: `Create a datapoint
+
+Creates a new datapoint in the specified dataset.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await datasetsCreateDatapoint(
+      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);
+  },
+};