Le premier plugin pour DeepSeek Harness
Dans Harness, un plugin est un module TypeScript qui exporte une fonction apply.
Le framework appelle apply lors du chargement du plugin, en passant un ctx (objet de contexte).
Nous enregistrons des capacités via ctx, telles que des écouteurs d'événements, des outils et des adaptateurs LLM.
ctxLe contexte est l'objet contexte que le framework transmet à chaque plugin.
ctxIl est à la fois le point d'entrée pour l'enregistrement des capacités et consigne toutes les ressources enregistrées par le plugin.
Créer un projet local
Nous devons d'abord installer à partir des sources :
git clone https://github.com/deepseek-ai/deepseek-harness.git cd deepseek-harness pnpm install pnpm run build pnpm dsh web
Ensuite, créez un projet scratch-plugin pour accueillir notre plugin.
Exécutez dans le répertoire racine du dépôt :
mkdir -p scratch-plugin/src
Plugin minimal : hello-plugin
Créez my-plugin.ts sous scratch-plugin/src.
cd scratch-plugin/src
Ci-dessous se trouve une configuration de plugin complète et utilisable—rien ne manque.
Exemple
import type { Context } from '@deepseek-ai/cordis'
// name est le nom du plugin, utilisé pour identifier ce plugin dans les journaux et la configuration.
export const name = 'hello-plugin'
// apply est le point d'entrée du plugin : le framework l'appelle lors du chargement du plugin.
export function apply(ctx: Context) {
// Les dépendances requises sont prêtes avant l'exécution de apply (voir Partie 9)
console.log('[hello-plugin] plugin chargé!')
}
Ce code ne fait qu'une seule chose : il affiche une ligne de journal lorsqu'il est chargé. Il n'enregistre aucune capacité, mais c'est déjà un plugin qualifié.
Trois formes de plugin
En plus de la forme fonction montrée ci-dessus, les plugins prennent également en charge la forme objet et la forme classe.
| Form | Syntaxe | Scénarios applicables |
|---|---|---|
| Forme fonction | Exporter une fonction apply indépendante | Pour la plupart des plugins, c'est l'approche la plus simple et la plus directe. |
| Forme objet | export default un objet avec name / inject / apply | Lorsque vous devez déclarer des métadonnées en même temps |
| Forme classe | export default d'une sous-classe Service | Lorsqu'un plugin doit fournir des services à d'autres plugins |
Forme fonction
Exporter name et apply séparément est le style par défaut dans les exemples officiels.
Exemple
import type { Context } from '@deepseek-ai/cordis'
export const name = 'my-plugin'
export function apply(ctx: Context) {
// Enregistrer les capacités ici
}
Forme objet
Placez name, inject et apply dans un objet exporté par défaut.
Exemple
import type { Context } from '@deepseek-ai/cordis'
export default {
name: 'my-plugin',
inject: ['tools'],
apply(ctx: Context) {
// ...
},
}
Forme classe
La forme de classe hérite de la classe de base Service et convient aux plugins qui fournissent des services en externe.
Exemple
import { Service, type Context } from '@deepseek-ai/cordis'
export default class MyService extends Service {
static inject = ['tools']
constructor(ctx: Context) {
// Le premier paramètre est ctx, le second est le nom du service
super(ctx, 'myService')
// Placer l'initialisation synchrone dans le constructeur
}
}
Comment choisir
Dans la plupart des cas, la forme fonctionnelle suffit.
Lorsqu'un plugin doit fournir des services à d'autres plugins, utilisez la forme de classe.
Astuce : le cœur de la forme de classe est super(ctx, 'service name').
Le mécanisme complet des services et des dépendances sera couvert dans la Partie 14.