Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
定义经过验证的本地工具、手动工具和可报告进度的工具。
defineTool() 接受描述、可选的 JSON 参数、运行时验证器、超时时间以及 execute() 函数。
import { defineTool } from "@phaseo/agent-sdk";
const fetchTicket = defineTool({
id: "fetch-ticket",
description: "Load one internal support ticket.",
parameters: {
type: "object",
properties: {
ticketId: { type: "string" },
},
required: ["ticketId"],
additionalProperties: false,
},
timeoutMs: 3_000,
async execute(input: { ticketId: string }, context) {
const response = await fetch(
`https://internal.example/tickets/${input.ticketId}`,
{ signal: context.signal },
);
return response.json();
},
});
context.signal，将运行标记为失败，并重新抛出超时错误。
Schema 可以是函数，也可以是公开 parse() 或 safeParse() 的对象。无效的模型参数和工具结果会在越过工具边界之前报错。
execute: false。在 toolOutputs 中提供结果，即可继续已暂停的运行。
对于交互式工具，请从 onToolCalled 返回 null。继续运行后，onResponseReceived 可以验证或转换传入的响应。
const indexRepository = defineTool({
id: "index-repository",
async *execute(input: { path: string }) {
yield { phase: "scan" };
yield { phase: "embed" };
return { indexed: 248 };
},
});
tool.preliminary_result 事件和步骤的 preliminaryResults 获取进度。
const agent = createAgent({
id: "research-agent",
toolExecution: {
toolConcurrency: 3,
},
tools: [fetchDocs, fetchStatus, fetchIncidents],
});