Aller au contenu

DOCUMENTATION

Clients OpenConnector : SDK, CLI, HTTP et MCP

Appelez le runtime avec le SDK TypeScript, oo CLI, HTTP ou MCP, en commençant par une Action publique Hacker News.

Maintenu par OOMOL·

Code source vérifié le 2026-09-09. Ces exemples ont été comparés à la révision du code indiquée. Cela ne constitue pas une vérification de l’API réelle du service ; votre version peut différer.

Quand utiliser OpenConnector

Utilisez OpenConnector lorsqu’un agent IA doit appeler des services tiers avec des comptes autorisés, ou lorsque vous souhaitez gérer les identifiants et les règles d’exécution dans votre propre infrastructure.

Comment démarrer

Choisissez un runtime auto-hébergé ou hébergé par OOMOL, connectez un compte, trouvez une Action et vérifiez son schéma d’entrée ainsi que ses permissions. Effectuez ensuite un petit appel en lecture seule et vérifiez le résultat.

Périmètre du runtime et de l’API

Ce domaine fournit des informations sur le projet et sa documentation, pas une API de connecteurs ni un serveur MCP en service. Envoyez les appels au runtime choisi. En auto-hébergement, consultez /openapi.json et /docs sur ce runtime. Les produits SaaS qui connectent les comptes de leurs propres utilisateurs doivent suivre le guide distinct d’intégration produit OOMOL.

Guide d’intégration produit ↗

Installer le CLI officiel oo

Installez oo en suivant le guide officiel, puis utilisez oo connector pour découvrir et appeler des Actions. Configurez l’URL du runtime, son jeton et les connexions aux comptes pour le déploiement choisi.

Installer le CLI officiel oo ↗

SDK TypeScript officiel

Installez @oomol-lab/connector depuis npm. Utilisez le client OpenConnector pour votre propre runtime ; pour les comptes personnels hébergés ou les connexions des utilisateurs d’un SaaS, suivez les guides OOMOL SDK.

npm
npm install @oomol-lab/connector
npm: @oomol-lab/connector ↗

Référence OpenAPI du runtime

Téléchargez la spécification générée à partir d’une révision figée du runtime. Définissez runtimeUrl sur votre propre déploiement avant de l’utiliser. Les schémas des Actions propres aux fournisseurs proviennent du catalogue de ce runtime. Ce site n’exécute pas d’appels API.

Référence OpenAPI du runtime →Code source du runtime· 72de05b ↗

TypeScript

Installez d’abord @oomol-lab/connector. Cet exemple appelle une instance locale d’OpenConnector depuis Node.js.

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

const connector = new OpenConnector({
  baseUrl: "http://localhost:3000",
  runtimeToken: process.env.OOMOL_CONNECT_RUNTIME_TOKEN,
});

const stories = await connector.hackernews.get_top_stories({});
console.log(stories);

CLI

Installez oo CLI, puis dirigez ses commandes connector vers votre environnement local. Les déploiements avec authentification nécessitent aussi un jeton d’accès au runtime.

CLI
oo connector login http://localhost:3000
oo connector search "Hacker News"
oo connector schema hackernews.get_top_stories
oo connector run hackernews --action get_top_stories --data '{}'

HTTP

Exécutez cette Action en lecture seule, sans authentification fournisseur, sur un environnement local. Ajoutez votre jeton Bearer si l’authentification du runtime est activée.

HTTP
curl -s -X POST \
  http://localhost:3000/v1/actions/hackernews.get_top_stories \
  -H 'content-type: application/json' \
  -d '{"input":{}}'

MCP

Configurez ce point d’accès HTTP MCP dans un hôte d’agent compatible. Consultez le guide de l’API du runtime pour l’authentification des clients et les outils disponibles.

MCP
http://localhost:3000/mcp

Lire le résultat

Les réponses HTTP du runtime contiennent success, message, data et meta. Vérifiez success et le schéma de sortie de l’Action, pas seulement le statut HTTP. Si les métadonnées contiennent executionId, utilisez-le pour retrouver le journal expurgé correspondant. L’exemple ci-dessous illustre le format ; ce n’est pas un résultat d’appel réel.

Exemple de format de réponse
{
  "success": true,
  "message": "OK",
  "data": {},
  "meta": {}
}

En cas d’échec

  • Pour une erreur d’authentification, vérifiez l’endpoint et le type d’identifiant : l’accès administrateur protège /api, le jeton Bearer runtime autorise /v1 et /mcp. Une clé API fournisseur ne remplace pas le jeton runtime.
  • Pour un refus d’accès, vérifiez les scopes requis, les règles d’Actions et les autorisations de connexion. Un jeton valide peut ne pas être autorisé à utiliser le compte choisi.
  • Si le résultat est vide ou incomplet, vérifiez le compte connecté et ses droits sur la ressource. Une autorisation réussie ne donne pas accès à tous les espaces, canaux ou documents.
  • Consultez l’erreur et le journal avant de réessayer. Si l’Action modifie les données du fournisseur, vérifiez d’abord si elle a déjà abouti ; ne répétez pas la requête aveuglément.
Lire en Markdown