Explorar documentación

Llamar a un runtime autoalojado con OpenConnector

Usa OpenConnector cuando tu código TypeScript llama a un runtime de OpenConnector que tú operas. Su baseUrl apunta a tu servidor.

Despliega y protege el servidor primero. La guía de autoalojamiento de OpenConnector cubre los despliegues con Docker Compose, código fuente y Cloudflare Workers.

Instalar el SDK

npm install @oomol-lab/connector

Llamar a un runtime local

Un runtime local recién creado usa http://localhost:3000 de forma predeterminada y se puede llamar sin un token de runtime hasta que se configuren los tokens. Mantén esta configuración sin token en localhost o en una red que sea privada:

import { OpenConnector } from "@oomol-lab/connector";

const open = new OpenConnector();

const stories = await open.execute("hackernews.get_top_stories", {});

La forma con espacio de nombres usa el mismo registro de acciones:

const threads = await open.gmail.search_threads({ query: "is:unread" });

Apuntar el cliente a tu servidor

Usa el origen del servidor como baseUrl. El cliente añade su propia ruta de API. Antes de hacer público el runtime, crea un token de runtime mientras todavía solo sea accesible desde una red de confianza, y luego exige ese token a todos los clientes:

const open = new OpenConnector({
  baseUrl: "https://connect.internal.example.com",
  runtimeToken: process.env.OOMOL_CONNECT_RUNTIME_TOKEN!,
  connectionName: "work",
});

El servidor exige un token oct_… válido después de que existan tokens de runtime. Guárdalo en el backend que realiza la llamada o en el entorno del Agent según tu política de despliegue. Nunca expongas un runtime sin token en un dominio público o túnel.

Inspeccionar el runtime

await open.health();
await open.catalog.services();
await open.catalog.search("send email", { limit: 5 });
await open.apps.listByService("github");
await open.apps.authenticated(["github", "notion"]);

Usa connectionName en el cliente o por llamada para seleccionar una cuenta configurada. Cuando no está presente ninguno de los dos, el runtime usa su conexión predeterminada.

Mantener la administración en la consola web

El SDK consume la configuración del runtime. Crea conexiones, configura clientes OAuth, genera tokens de runtime y gestiona la política de acciones en la consola web de OpenConnector.

Consulta la referencia del SDK de TypeScript para conocer los tipos de acción precisos, las diferencias de proxy, los tiempos de espera, los reintentos, los errores y la API OpenConnector completa.