DeepSeek Harness Primer plugin

En Harness, un plugin es un módulo de TypeScript que exporta una función apply.

El framework llama a apply al cargar el plugin y le pasa un ctx (objeto de contexto).

A través de ctx registramos capacidades, como escuchadores de eventos, herramientas y adaptadores de LLM.

ctx(Context) es el objeto de contexto que el framework pasa a cada plugin.

ctxEs a la vez la entrada para registrar capacidades y el registro de todos los recursos que el plugin ha registrado.


Crear un proyecto local

Primero necesitamos instalar desde el código fuente:

git clone https://github.com/deepseek-ai/deepseek-harness.git
cd deepseek-harness
pnpm install
pnpm run build
pnpm dsh web

A continuación, crea un proyecto scratch-plugin para alojar nuestro plugin.

Ejecuta en el directorio raíz del repositorio:

mkdir -p scratch-plugin/src

Plugin mínimo: hello-plugin

Crea my-plugin.ts dentro de scratch-plugin/src.

cd scratch-plugin/src

A continuación se muestra una configuración de plugin completamente funcional, sin que falte nada.

Ejemplo

// Ruta del archivo: scratch-plugin/src/my-plugin.ts
import type { Context } from '@deepseek-ai/cordis'

// name es el nombre del plugin, se utiliza para identificar este plugin en los registros y la configuración
export const name = 'hello-plugin'

// apply es el punto de entrada del plugin: el framework lo llama al cargar el plugin
export function apply(ctx: Context) {
  // Las dependencias necesarias ya están listas antes de que se ejecute apply (ver artículo 9)
  console.log('[hello-plugin] plugin loaded!')
}

Este código solo hace una cosa: imprime una línea de registro al cargarse. No registra ninguna capacidad, pero ya es un plugin válido.


Las tres formas de un plugin

Además de la forma de función vista anteriormente, los plugins también admiten la forma de objeto y la forma de clase.

FormaSintaxisEscenario de uso
Forma de funciónExportar una función apply independienteLa mayoría de los plugins, el método más simple y directo
Forma de objetoexport default un objeto con name / inject / applyCuando se necesita declarar metainformación al mismo tiempo
Forma de claseexport default una subclase de ServiceCuando el plugin necesita proporcionar servicios a otros plugins

Forma de función

Exportar name y apply por separado es la forma predeterminada en los ejemplos oficiales.

Ejemplo

// Ruta del archivo: scratch-plugin/src/my-plugin.ts (forma de función)
import type { Context } from '@deepseek-ai/cordis'

export const name = 'my-plugin'

export function apply(ctx: Context) {
  // Aquí se registran las capacidades
}

Forma de objeto

Coloca name, inject y apply en un objeto de exportación predeterminada.

Ejemplo

// Forma de objeto: un objeto de exportación predeterminada
import type { Context } from '@deepseek-ai/cordis'

export default {
  name: 'my-plugin',
  inject: ['tools'],
  apply(ctx: Context) {
    // ...
  },
}

Forma de clase

La forma de clase hereda de la clase base Service y es adecuada para plugins que ofrecen servicios al exterior.

Ejemplo

// Forma de clase: subclase de Service, puede proporcionar servicios al exterior
import { Service, type Context } from '@deepseek-ai/cordis'

export default class MyService extends Service {
  static inject = ['tools']

  constructor(ctx: Context) {
    // El primer parámetro es ctx, el segundo parámetro es el nombre del servicio
    super(ctx, 'myService')
    // La inicialización síncrona se coloca en el constructor
  }
}

Cómo elegir

En la mayoría de los casos, la forma de función es suficiente.

Cuando el plugin necesita proporcionar servicios a otros plugins, usa la forma de clase.

Consejo: el núcleo de la forma de clase es super(ctx, 'nombre del servicio').

El mecanismo completo de servicios y dependencias se desarrollará en el artículo 14.

插件结构与加载示意

Otras extensiones