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);
  }
}

import { query } from '@qwen-code/sdk';
 
const q = query({
  prompt: 'Your prompt',
  options: {
    timeout: {
      canUseTool: 60000, // 权限回调 60 秒
      mcpRequest: 600000, // MCP 工具调用 10 分钟
      controlRequest: 60000, // 控制请求 60 秒
      streamClose: 15000, // 流关闭等待 15 秒
    },
  },
});

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: 'Hello', options: {} });
 
// 获取会话 ID
const sessionId = q.getSessionId();
 
// 检查是否已关闭
const closed = q.isClosed();
 
// 中断当前操作
await q.interrupt();
 
// 在会话中更改权限模式
await q.setPermissionMode('yolo');
 
// 在会话中更改模型
await q.setModel('qwen-max');
 
// 获取上下文窗口使用情况细分（各类别的 token 数）
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: '用一句话问好。',
  options: {
    systemPrompt: '你是一个简洁的助手。请用一句话回答。',
  },
});

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',
  '将两个数字相加',
  { 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: '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 {
    // 处理其他错误
  }
}