Appeler un runtime auto-hébergé avec OpenConnector

Utilisez OpenConnector lorsque votre code TypeScript appelle un runtime OpenConnector que vous exploitez. Son baseUrl pointe vers votre serveur.

Déployez et protégez d’abord le serveur. Le guide d’auto-hébergement d’OpenConnector couvre les déploiements avec Docker Compose, depuis les sources et sur Cloudflare Workers.

Installer le SDK

npm install @oomol-lab/connector

Appeler un runtime local

Un nouveau runtime local utilise par défaut http://localhost:3000 et peut être appelé sans jeton runtime tant qu’aucun jeton n’est configuré. Réservez cette configuration sans jeton à localhost ou à un réseau privé :

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

const open = new OpenConnector();

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

La forme namespace utilise le même registre d’opérations :

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

Faire pointer le client vers votre serveur

Utilisez l’origine du serveur comme baseUrl. Le client ajoute son propre chemin d’API. Avant de rendre le runtime public, créez un jeton runtime lorsqu’il est encore accessible uniquement depuis un réseau de confiance, puis exigez ce jeton de chaque client :

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

Le serveur exige un jeton oct_… valide dès qu’il existe des jetons runtime. Conservez-le dans le backend appelant ou l’environnement de l’Agent conformément à votre politique de déploiement. N’exposez jamais un runtime sans jeton sur un domaine ou un tunnel public.

Inspecter le 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"]);

Utilisez connectionName sur le client ou pour chaque appel afin de sélectionner un compte configuré. En son absence, le runtime utilise sa connexion par défaut.

Réserver l’administration à la console web

Le SDK consomme la configuration du runtime. Créez les connexions, configurez les clients OAuth, générez les jetons runtime et gérez la politique des opérations dans la console web d’OpenConnector.

Consultez la référence du SDK TypeScript pour les types précis des opérations, les différences de proxy, les délais d’expiration, les nouvelles tentatives, les erreurs et l’API OpenConnector complète.