openrouter-agent-migration

从 @openrouter/sdk 迁移到 @openrouter/agent

Agent 功能（callModel、tool()、停止条件、格式转换器、流式处理辅助工具）已从 @openrouter/sdk 移至独立的 @openrouter/agent 包。@openrouter/agent 包包含自己的 OpenRouter 客户端类，因此在使用 Agent 功能时无需安装 @openrouter/sdk。

---

适用情况

如果你的代码从 @openrouter/sdk 导入以下任何内容，请进行迁移：

• callModel，或使用 client.callModel()
• tool() 工厂函数
• 停止条件：stepCountIs、hasToolCall、maxCost、maxTokensUsed、finishReasonIs
• 格式转换器：fromClaudeMessages、toClaudeMessage、fromChatMessages、toChatMessage
• 类型：Tool、ToolWithExecute、ToolWithGenerator、ManualTool、CallModelInput、ModelResult

---

快速迁移

第 1 步：安装

npm install @openrouter/agent

如果你只使用 Agent 功能，可以移除 @openrouter/sdk：

npm uninstall @openrouter/sdk
npm install @openrouter/agent

如果你还使用非 Agent 的 SDK 功能（模型列表、聊天补全、额度、OAuth、API 密钥），请保留这两个包。

第 2 步：更新导入语句

OpenRouter 客户端类和 client.callModel() 用法完全相同，只需更改导入来源：

- import OpenRouter from '@openrouter/sdk';
+ import { OpenRouter } from '@openrouter/agent';

其余代码保持不变：

const client = new OpenRouter({ apiKey: process.env.OPENROUTER_API_KEY });

const result = client.callModel({
  model: 'openai/gpt-5-nano',
  input: 'Hello!',
});

const text = await result.getText();

---

完整导入映射

客户端与 callModel

旧版	新版
import OpenRouter from '@openrouter/sdk'	import { OpenRouter } from '@openrouter/agent'
import OpenRouter, { tool, stepCountIs } from '@openrouter/sdk'	import { OpenRouter } from '@openrouter/agent' import { tool } from '@openrouter/agent/tool' import { stepCountIs } from '@openrouter/agent/stop-conditions'

对于已有 OpenRouterCore 实例的高级使用场景，也可以使用独立的 callModel 函数：

import { callModel } from '@openrouter/agent/call-model';

// Requires an OpenRouterCore instance (from @openrouter/sdk/core)
const result = callModel(coreInstance, { model: 'openai/gpt-5-nano', input: 'Hello' });

对于大多数使用场景，建议使用上文所示的 client.callModel() 方法。

创建工具

旧版	新版
import { tool } from '@openrouter/sdk'	import { tool } from '@openrouter/agent/tool'

停止条件

旧版	新版
import { stepCountIs, hasToolCall, maxCost } from '@openrouter/sdk'	import { stepCountIs, hasToolCall, maxCost } from '@openrouter/agent/stop-conditions'
import { maxTokensUsed, finishReasonIs } from '@openrouter/sdk'	import { maxTokensUsed, finishReasonIs } from '@openrouter/agent/stop-conditions'

类型

旧版	新版
import type { Tool, ToolWithExecute, ToolWithGenerator, ManualTool } from '@openrouter/sdk/lib/tool-types'	import type { Tool, ToolWithExecute, ToolWithGenerator, ManualTool } from '@openrouter/agent/tool-types'
import type { CallModelInput } from '@openrouter/sdk/lib/async-params'	import type { CallModelInput } from '@openrouter/agent/async-params'
import { ModelResult } from '@openrouter/sdk/lib/model-result'	import { ModelResult } from '@openrouter/agent/model-result'

格式转换器

旧版	新版
import { fromClaudeMessages, toClaudeMessage } from '@openrouter/sdk'	import { fromClaudeMessages, toClaudeMessage } from '@openrouter/agent'
import { fromChatMessages, toChatMessage } from '@openrouter/sdk'	import { fromChatMessages, toChatMessage } from '@openrouter/agent'

类型守卫

旧版	新版
import { hasExecuteFunction, isGeneratorTool, isRegularExecuteTool } from '@openrouter/sdk'	import { hasExecuteFunction, isGeneratorTool, isRegularExecuteTool } from '@openrouter/agent/tool-types'

---

迁移前后示例

迁移前（使用 @openrouter/sdk）

import OpenRouter, { tool, stepCountIs, hasToolCall } from '@openrouter/sdk';
import { z } from 'zod';

const client = new OpenRouter({
  apiKey: process.env.OPENROUTER_API_KEY,
});

const searchTool = tool({
  name: 'web_search',
  description: 'Search the web',
  inputSchema: z.object({ query: z.string() }),
  outputSchema: z.object({ results: z.array(z.string()) }),
  execute: async ({ query }) => {
    return { results: ['Result 1', 'Result 2'] };
  },
});

const finishTool = tool({
  name: 'finish',
  description: 'Complete the task',
  inputSchema: z.object({ answer: z.string() }),
  execute: async ({ answer }) => ({ answer }),
});

const result = client.callModel({
  model: 'openai/gpt-5-nano',
  instructions: 'You are a research assistant.',
  input: 'What are the latest AI developments?',
  tools: [searchTool, finishTool],
  stopWhen: [stepCountIs(10), hasToolCall('finish')],
});

const text = await result.getText();

迁移后（使用 @openrouter/agent）

import { OpenRouter } from '@openrouter/agent';
import { tool } from '@openrouter/agent/tool';
import { stepCountIs, hasToolCall } from '@openrouter/agent/stop-conditions';
import { z } from 'zod';

const client = new OpenRouter({
  apiKey: process.env.OPENROUTER_API_KEY,
});

const searchTool = tool({
  name: 'web_search',
  description: 'Search the web',
  inputSchema: z.object({ query: z.string() }),
  outputSchema: z.object({ results: z.array(z.string()) }),
  execute: async ({ query }) => {
    return { results: ['Result 1', 'Result 2'] };
  },
});

const finishTool = tool({
  name: 'finish',
  description: 'Complete the task',
  inputSchema: z.object({ answer: z.string() }),
  execute: async ({ answer }) => ({ answer }),
});

const result = client.callModel({
  model: 'openai/gpt-5-nano',
  instructions: 'You are a research assistant.',
  input: 'What are the latest AI developments?',
  tools: [searchTool, finishTool],
  stopWhen: [stepCountIs(10), hasToolCall('finish')],
});

const text = await result.getText();

唯一的改动是顶部的三行导入语句。

---

何时保留 @openrouter/sdk

如果你使用以下任何非 Agent 功能，请保留已安装的 @openrouter/sdk：

功能	调用方式
模型列表	client.models.list()
聊天补全	client.chat.send()
旧版补全	client.completions.generate()
用量分析	client.analytics.getUserActivity()
额度余额	client.credits.getCredits()
API 密钥管理	client.apiKeys.list()、.create() 等
OAuth PKCE 流程	client.oAuth.createAuthCode()、.exchangeAuthCodeForAPIKey()

对于混合项目，使用 @openrouter/sdk 实现这些功能，并使用 @openrouter/agent 实现 Agent 功能：

import OpenRouter from '@openrouter/sdk';               // SDK client for models, credits, etc.
import { OpenRouter as Agent } from '@openrouter/agent'; // Agent client for callModel
import { tool } from '@openrouter/agent/tool';
import { stepCountIs } from '@openrouter/agent/stop-conditions';

// Use SDK client for non-agent features
const sdkClient = new OpenRouter({ apiKey: process.env.OPENROUTER_API_KEY });
const models = await sdkClient.models.list();
const credits = await sdkClient.credits.getCredits();

// Use Agent client for callModel
const agent = new Agent({ apiKey: process.env.OPENROUTER_API_KEY });
const result = agent.callModel({
  model: 'openai/gpt-5-nano',
  input: 'Hello!',
  tools: [myTool],
  stopWhen: stepCountIs(5),
});

---

@openrouter/agent 的新功能

这些功能仅在 @openrouter/agent 中提供，@openrouter/sdk 中没有：

共享上下文架构

对话中所有工具之间类型安全的共享状态：

import { OpenRouter } from '@openrouter/agent';
import { z } from 'zod';

const client = new OpenRouter({ apiKey: '...' });

const result = client.callModel({
  model: 'openai/gpt-5-nano',
  input: 'Process this data',
  sharedContextSchema: z.object({
    userId: z.string(),
    sessionData: z.record(z.unknown()),
  }),
  context: {
    shared: { userId: '123', sessionData: {} },
  },
  tools: [myTool],
});

工具上下文

工具可以声明自己的类型化上下文并访问共享上下文：

import { tool } from '@openrouter/agent/tool';
import { z } from 'zod';

const myTool = tool({
  name: 'my_tool',
  description: 'A tool with context',
  inputSchema: z.object({ query: z.string() }),
  contextSchema: z.object({ apiKey: z.string() }),
  execute: async (params, context) => {
    // context.local — this tool's own context
    // context.shared — shared context across all tools
    // context.setContext({ ... }) — update this tool's context
    // context.setSharedContext({ ... }) — update shared context
    return { result: 'done' };
  },
});

工具审批流程

要求用户在执行工具前审批：

const dangerousTool = tool({
  name: 'delete_file',
  description: 'Delete a file',
  inputSchema: z.object({ path: z.string() }),
  requireApproval: true, // or a function: (toolCall, context) => boolean
  execute: async ({ path }) => { /* ... */ },
});

轮次生命周期回调

const result = client.callModel({
  model: 'openai/gpt-5-nano',
  input: 'Complex task',
  tools: [myTool],
  onTurnStart: async (context) => {
    console.log(`Starting turn ${context.numberOfTurns}`);
  },
  onTurnEnd: async (context, response) => {
    console.log(`Turn ${context.numberOfTurns} complete`);
  },
});

---

所有子路径导出

@openrouter/agent 提供精细化的子路径导入：

子路径	导出内容
@openrouter/agent	汇总入口：包含以下所有导出
@openrouter/agent/client	OpenRouter 类
@openrouter/agent/call-model	callModel 独立函数
@openrouter/agent/tool	tool() 工厂函数
@openrouter/agent/tool-types	Tool、ToolWithExecute、ToolWithGenerator、ManualTool、类型守卫
@openrouter/agent/stop-conditions	stepCountIs、hasToolCall、maxCost、maxTokensUsed、finishReasonIs
@openrouter/agent/model-result	ModelResult 响应包装器
@openrouter/agent/async-params	CallModelInput、hasAsyncFunctions、resolveAsyncFunctions
@openrouter/agent/anthropic-compat	fromClaudeMessages、toClaudeMessage
@openrouter/agent/chat-compat	fromChatMessages、toChatMessage
@openrouter/agent/conversation-state	createInitialState、updateState、appendToMessages
@openrouter/agent/next-turn-params	nextTurnParams 工具函数
@openrouter/agent/stream-transformers	extractUnsupportedContent、getUnsupportedContentSummary
@openrouter/agent/tool-context	buildToolExecuteContext、ToolContextStore
@openrouter/agent/tool-event-broadcaster	ToolEventBroadcaster
@openrouter/agent/turn-context	buildTurnContext