チャネルプラグイン開発者ガイド

Your Plugin  →  builds Envelope  →  handleInbound()
ChannelBase  →  gates → commands → routing → ChannelAgentBridge.prompt()
ChannelBase  →  calls your sendMessage() with the agent's response

import type { ChannelPlugin } from '@qwen-code/channel-base';
import { MyChannel } from './MyChannel.js';
 
export const plugin: ChannelPlugin = {
  channelType: 'my-platform', // 一意の ID。settings.json の "type" フィールドで使用
  displayName: 'My Platform', // CLI 出力に表示される
  requiredConfigFields: ['apiKey'], // 起動時に検証される（標準の ChannelConfig 以外）
  createChannel: (name, config, bridge, options) =>
    new MyChannel(name, config, bridge, options),
};

import { ChannelBase } from '@qwen-code/channel-base';
import type {
  ChannelBaseOptions,
  ChannelAgentBridge,
  ChannelConfig,
  Envelope,
} from '@qwen-code/channel-base';
 
export class MyChannel extends ChannelBase {
  constructor(
    name: string,
    config: ChannelConfig,
    bridge: ChannelAgentBridge,
    options?: ChannelBaseOptions,
  ) {
    super(name, config, bridge, options);
  }
 
  async connect(): Promise<void> {
    // プラットフォームに接続し、メッセージハンドラを登録
    // メッセージが届いたら:
    const envelope: Envelope = {
      channelName: this.name,
      senderId: '...', // 安定した、一意のプラットフォームユーザー ID
      senderName: '...', // 表示名
      chatId: '...', // チャット/会話 ID（DM とグループで区別）
      text: '...', // メッセージテキスト（@メンションを除去）
      isGroup: false, // 正確に設定 — GroupGate で使用
      isMentioned: false, // 正確に設定 — GroupGate で使用
      isReplyToBot: false, // 正確に設定 — GroupGate で使用
    };
    this.handleInbound(envelope);
  }
 
  async sendMessage(chatId: string, text: string): Promise<void> {
    // マークダウンをプラットフォーム形式にフォーマットし、必要に応じて分割して配信
  }
 
  disconnect(): void {
    // 接続をクリーンアップ
  }
}

interface Attachment {
  type: 'image' | 'file' | 'audio' | 'video';
  data?: string; // base64 エンコードされたデータ（画像、小さなファイル）
  filePath?: string; // ローカルファイルへの絶対パス（ディスクに保存された大きなファイル）
  mimeType: string; // 例: 'application/pdf', 'image/jpeg'
  fileName?: string; // プラットフォームからの元のファイル名
}

import { writeFileSync, mkdirSync, existsSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
 
const buf = await downloadFromPlatform(fileId);
const dir = join(tmpdir(), 'channel-files');
if (!existsSync(dir)) mkdirSync(dir, { recursive: true });
const filePath = join(dir, fileName);
writeFileSync(filePath, buf);
 
envelope.attachments = [
  {
    type: 'file',
    filePath,
    mimeType: 'application/pdf',
    fileName,
  },
];

{
  "name": "my-channel-extension",
  "version": "1.0.0",
  "channels": {
    "my-platform": {
      "entry": "dist/index.js",
      "displayName": "My Platform Channel"
    }
  }
}

this.registerCommand('mycommand', async (envelope, args) => {
  await this.sendMessage(envelope.chatId, 'Response');
  return true; // 処理済み、エージェントに転送しない
});

protected override onPromptStart(chatId: string, sessionId: string, messageId?: string): void {
  this.platformClient.sendTyping(chatId); // プラットフォームの API
}
 
protected override onPromptEnd(chatId: string, sessionId: string, messageId?: string): void {
  this.platformClient.stopTyping(chatId);
}