DeepSeek Harness 最初のプラグイン

Harness では、プラグインは apply 関数をエクスポートする TypeScript モジュールです。

フレームワークはプラグインを読み込むときに apply を呼び出し、ctx(コンテキストオブジェクト)を渡します。

私たちは ctx を通じて、イベントリスナー、ツール、LLM アダプターなどの機能を登録します。

ctx(Context)はフレームワークが各プラグインに渡すコンテキストオブジェクトです。

ctxこれは機能を登録する入り口であると同時に、プラグインが登録したすべてのリソースを記録します。


ローカルプロジェクトの作成

まずソースコードからインストールする必要があります:

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

次に、プラグインを置くための scratch-plugin プロジェクトを作成します。

リポジトリのルートディレクトリで実行します:

mkdir -p scratch-plugin/src

最小プラグイン:hello-plugin

scratch-plugin/src の下に my-plugin.ts を作成します。

cd scratch-plugin/src

以下は完全に動作するプラグイン設定で、何も欠けていません。

例

// ファイルパス:scratch-plugin/src/my-plugin.ts
import type { Context } from '@deepseek-ai/cordis'

// name はプラグイン名で、ログと設定でこのプラグインを識別するために使われます
export const name = 'hello-plugin'

// apply はプラグインのエントリーポイントです:フレームワークがプラグインを読み込むときに呼び出します
export function apply(ctx: Context) {
  // 必要な依存関係は apply の実行前に準備されています(第9篇を参照)
  console.log('[hello-plugin] plugin loaded!')
}

このコードは1つのことだけを行います:読み込み時に1行のログを出力します。何の機能も登録していませんが、すでに合格したプラグインです。


プラグインの3つの形態

上記の関数形式に加えて、プラグインはオブジェクト形式とクラス形式もサポートしています。

形態書き方適用シーン
関数形式独立した apply 関数をエクスポートほとんどのプラグインに適しており、最もシンプルで直接的な方法
オブジェクト形式name / inject / apply を持つオブジェクトを export default するメタ情報も同時に宣言する必要がある場合
クラス形式Service サブクラスを export default するプラグインが他のプラグインにサービスを提供する必要がある場合

関数形式

name と apply を別々にエクスポートするのは、公式サンプルのデフォルトの書き方です。

例

// ファイルパス:scratch-plugin/src/my-plugin.ts(関数形式)
import type { Context } from '@deepseek-ai/cordis'

export const name = 'my-plugin'

export function apply(ctx: Context) {
  // ここで機能を登録します
}

オブジェクト形式

name、inject、apply をデフォルトエクスポートする1つのオブジェクトに入れます。

例

// オブジェクト形式:デフォルトエクスポートのオブジェクト
import type { Context } from '@deepseek-ai/cordis'

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

クラス形式

クラス形式は Service 基底クラスを継承し、外部にサービスを提供するプラグインに適しています。

例

// クラス形式:Service サブクラスで、外部にサービスを提供可能
import { Service, type Context } from '@deepseek-ai/cordis'

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

  constructor(ctx: Context) {
    // 最初の引数は ctx、2番目の引数はサービス名です
    super(ctx, 'myService')
    // 同期初期化はコンストラクターに置きます
  }
}

選び方

ほとんどの場合、関数形式で十分です。

プラグインが他のプラグインにサービスを提供する必要がある場合は、クラス形式を使用します。

ヒント:クラス形式の核心は super(ctx, 'サービス名') です。

サービスと依存関係の完全なメカニズムは第14篇で詳しく説明します。

插件结构与加载示意

その他の拡張