Первый плагин для DeepSeek Harness
В Harness плагин — это модуль TypeScript, который экспортирует функцию apply.
Фреймворк вызывает apply при загрузке плагина, передавая ctx (объект контекста).
Мы регистрируем возможности через ctx, такие как слушатели событий, инструменты и адаптеры LLM.
ctxContext — это объект контекста, который фреймворк передаёт каждому плагину.
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
Создайте my-plugin.ts в scratch-plugin/src.
cd scratch-plugin/src
Ниже приведена полная, рабочая конфигурация плагина — ничего не пропущено.
Пример
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!')
}
Этот код делает только одно: он выводит строку лога при загрузке. Он не регистрирует никаких возможностей, но это уже полноценный плагин.
Три формы плагина
В дополнение к функциональной форме, показанной выше, плагины также поддерживают объектную форму и форму класса.
| Form | Синтаксис | Применимые сценарии |
|---|---|---|
| Функциональная форма | Экспортируйте независимую функцию apply | Для большинства плагинов это самый простой и прямой подход. |
| Объектная форма | export default объект с name / inject / apply | Когда нужно одновременно объявить метаданные |
| Форма класса | export default — подкласс Service | Когда плагину нужно предоставлять сервисы другим плагинам |
Функциональная форма
Экспорт name и apply по отдельности — стиль по умолчанию в официальных примерах.
Пример
import type { Context } from '@deepseek-ai/cordis'
export const name = 'my-plugin'
export function apply(ctx: Context) {
// Регистрируйте возможности здесь
}
Объектная форма
Поместите name, inject и apply в объект, экспортируемый по умолчанию.
Пример
import type { Context } from '@deepseek-ai/cordis'
export default {
name: 'my-plugin',
inject: ['tools'],
apply(ctx: Context) {
// ...
},
}
Форма класса
Классовая форма наследует базовый класс Service и подходит для плагинов, которые предоставляют сервисы наружу.
Пример
import { Service, type Context } from '@deepseek-ai/cordis'
export default class MyService extends Service {
static inject = ['tools']
constructor(ctx: Context) {
// Первый параметр — ctx, второй — имя сервиса
super(ctx, 'myService')
// Поместите синхронную инициализацию в конструктор
}
}
Как выбрать
В большинстве случаев функциональной формы достаточно.
Когда плагину нужно предоставлять сервисы другим плагинам, используйте классовую форму.
Совет: ядро классовой формы — super(ctx, 'service name').
Полный механизм сервисов и зависимостей будет рассмотрен в части 14.