TypeScript SDK

npm install @qwen-code/sdk

import { query } from '@qwen-code/sdk';
 
// シングルターンのクエリ
const result = query({
  prompt: '今いるディレクトリにはどんなファイルがありますか？',
  options: {
    cwd: '/path/to/project',
  },
});
 
// メッセージを反復処理
for await (const message of result) {
  if (message.type === 'assistant') {
    console.log('Assistant:', message.message.content);
  } else if (message.type === 'result') {
    console.log('Result:', message.result);
  }
}

const q = query({
  prompt: 'Your prompt',
  options: {
    timeout: {
      canUseTool: 60000, // 60 seconds for permission callback
      mcpRequest: 600000, // 10 minutes for MCP tool calls
      controlRequest: 60000, // 60 seconds for control requests
      streamClose: 15000, // 15 seconds for stream close wait
    },
  },
});

import {
  isSDKUserMessage,
  isSDKAssistantMessage,
  isSDKSystemMessage,
  isSDKResultMessage,
  isSDKPartialAssistantMessage,
} from '@qwen-code/sdk';
 
for await (const message of result) {
  if (isSDKAssistantMessage(message)) {
    // アシスタントメッセージを処理
  } else if (isSDKResultMessage(message)) {
    // 結果メッセージを処理
  }
}

const q = query({ prompt: 'こんにちは', options: {} });
 
// セッション ID を取得
const sessionId = q.getSessionId();
 
// クローズ状態の確認
const closed = q.isClosed();
 
// 現在の操作を中断
await q.interrupt();
 
// セッション中にパーミッションモードを変更
await q.setPermissionMode('yolo');
 
// セッション中にモデルを変更
await q.setModel('qwen-max');
 
// コンテキストウィンドウの使用状況内訳を取得（カテゴリ別トークン数）
const usage = await q.getContextUsage();
// true を渡すと、アイテムごとの詳細を表示するヒントを与える
const detail = await q.getContextUsage(true);
 
// セッションを閉じる
await q.close();

import { DaemonClient } from '@qwen-code/sdk';
 
const daemon = new DaemonClient({ baseUrl: 'http://127.0.0.1:4170' });
const session = await daemon.createOrAttachSession({
  workspaceCwd: '/path/to/project',
  sessionId: '550E8400-E29B-41D4-A716-446655440000',
});
 
console.log(session.sessionId); // 550e8400-e29b-41d4-a716-446655440000

import { PeerEndpoint } from '@qwen-code/sdk/peer';
 
const endpoint = await PeerEndpoint.start({
  name: 'voice-bridge',
  onMessage: (message) =>
    console.log(`${message.fromName}: ${message.content}`),
});
 
const [session] = await endpoint.list();
if (session) {
  const sent = await endpoint.send({
    to: session.address,
    content: 'What are you working on?',
  });
  if (sent.kind === 'sent') {
    const receipt = await endpoint.awaitReceipt(sent.msgId, { final: true });
    console.log(receipt?.status); // delivered, denied, refused, ...
  }
}
 
await endpoint.close();

const endpoint = await PeerEndpoint.start({
  name: 'voice-bridge',
  controllerToken: process.env['QWEN_CONTROLLER_TOKEN'],
});
await endpoint.send({
  to: 'my-app-3f',
  content: 'run the tests',
  controller: true,
});

import { query, type SDKUserMessage } from '@qwen-code/sdk';
 
async function* generateMessages(): AsyncIterable<SDKUserMessage> {
  yield {
    type: 'user',
    session_id: 'my-session',
    message: { role: 'user', content: 'hello.txt ファイルを作成してください' },
    parent_tool_use_id: null,
  };
 
  // 何らかの条件やユーザー入力を待つ
  yield {
    type: 'user',
    session_id: 'my-session',
    message: { role: 'user', content: '今度はそのファイルを読み込んでください' },
    parent_tool_use_id: null,
  };
}
 
const result = query({
  prompt: generateMessages(),
  options: {
    permissionMode: 'auto-edit',
  },
});
 
for await (const message of result) {
  console.log(message);
}

import { query, type CanUseTool } from '@qwen-code/sdk';
 
const canUseTool: CanUseTool = async (toolName, input, { signal }) => {
  // 読み取り操作はすべて許可
  if (toolName.startsWith('read_')) {
    return { behavior: 'allow', updatedInput: input };
  }
 
  // 書き込み操作はユーザーに確認（実際のアプリでは）
  const userApproved = await promptUser(`${toolName} を許可しますか？`);
 
  if (userApproved) {
    return { behavior: 'allow', updatedInput: input };
  }
 
  return { behavior: 'deny', message: 'ユーザーが操作を拒否しました' };
};
 
const result = query({
  prompt: '新しいファイルを作成してください',
  options: {
    canUseTool,
  },
});

import { query } from '@qwen-code/sdk';
 
const result = query({
  prompt: 'MCP サーバーのカスタムツールを使ってください',
  options: {
    mcpServers: {
      'my-server': {
        command: 'node',
        args: ['path/to/mcp-server.js'],
        env: { PORT: '3000' },
      },
    },
  },
});

import { query } from '@qwen-code/sdk';
 
const result = query({
  prompt: '1文で挨拶してください。',
  options: {
    systemPrompt: 'あなたは簡潔なアシスタントです。ちょうど1文で答えてください。',
  },
});

import { query } from '@qwen-code/sdk';
 
const result = query({
  prompt: '現在のディレクトリをレビューしてください。',
  options: {
    systemPrompt: {
      type: 'preset',
      preset: 'qwen_code',
      append: '簡潔にし、具体的な発見に焦点を当ててください。',
    },
  },
});

{
  content: Array<
    | { type: 'text'; text: string }
    | { type: 'image'; data: string; mimeType: string }
    | { type: 'resource'; uri: string; mimeType?: string; text?: string }
  >;
  isError?: boolean;
}

import { z } from 'zod';
import { query, tool, createSdkMcpServer } from '@qwen-code/sdk';
 
// Zodスキーマでツールを定義
const calculatorTool = tool(
  'calculate_sum',
  '2つの数値を加算',
  { a: z.number(), b: z.number() },
  async (args) => ({
    content: [{ type: 'text', text: String(args.a + args.b) }],
  }),
);
 
// MCPサーバーを作成
const server = createSdkMcpServer({
  name: 'calculator',
  tools: [calculatorTool],
});
 
// クエリでサーバーを使用
const result = query({
  prompt: 'What is 42 + 17?',
  options: {
    permissionMode: 'yolo',
    mcpServers: {
      calculator: server,
    },
  },
});
 
for await (const message of result) {
  console.log(message);
}

import { query, isAbortError } from '@qwen-code/sdk';
 
const abortController = new AbortController();
 
const result = query({
  prompt: '長時間実行タスク...',
  options: {
    abortController,
  },
});
 
// 5秒後に中断
setTimeout(() => abortController.abort(), 5000);
 
try {
  for await (const message of result) {
    console.log(message);
  }
} catch (error) {
  if (isAbortError(error)) {
    console.log('クエリが中断されました');
  } else {
    throw error;
  }
}

import { AbortError, isAbortError } from '@qwen-code/sdk';
 
try {
  // ... クエリ操作
} catch (error) {
  if (isAbortError(error)) {
    // 中断の処理
  } else {
    // その他のエラーの処理
  }
}