后工具使用钩子

注意

Copilot SDK 当前处于技术预览版. 功能和可用性可能会发生更改。

执行 onPostToolUse 工具后调用挂钩。使用它可执行以下操作：

转换或筛选工具结果
用于审核的日志工具执行
基于结果添加上下文
隐藏对话的结果

挂钩签名

import type { PostToolUseHookInput, HookInvocation, PostToolUseHookOutput } from "@github/copilot-sdk";
type PostToolUseHandler = (
  input: PostToolUseHookInput,
  invocation: HookInvocation
) => Promise<PostToolUseHookOutput | null | undefined>;

有关 Python、Go 和 .NET 中的挂钩签名，请参阅 github/copilot-sdk 存储库。

输入

领域	类型	说明
`timestamp`	number	触发挂钩时的 Unix 时间戳
`cwd`	字符串	当前工作目录
`toolName`	字符串	已调用的工具的名称
`toolArgs`	对象	传递给工具的参数
`toolResult`	对象	工具返回的结果

输出

返回 null 或 undefined 传递结果不变。否则，返回具有以下任何字段的对象。

领域	类型	说明
`modifiedResult`	对象	要使用的修改结果，而不是原始结果
`additionalContext`	字符串	注入到会话中的额外上下文
`suppressOutput`	布尔	如果为 true，则结果不会显示在对话中

示例

记录所有工具结果

const session = await client.createSession({
  hooks: {
    onPostToolUse: async (input, invocation) => {
      console.log(
        `[${invocation.sessionId}] `
        + `Tool: ${input.toolName}`
      );
      console.log(
        `  Args: ${JSON.stringify(input.toolArgs)}`
      );
      console.log(
        `  Result: `
        + `${JSON.stringify(input.toolResult)}`
      );
      return null; // Pass through unchanged
    },
  },
});

有关 Python、Go 和 .NET 中的示例，请参阅 github/copilot-sdk 存储库。

对敏感数据进行修订

const SENSITIVE_PATTERNS = [
  /api[_-]?key["\s:=]+["']?[\w-]+["']?/gi,
  /password["\s:=]+["']?[\w-]+["']?/gi,
  /secret["\s:=]+["']?[\w-]+["']?/gi,
];

const session = await client.createSession({
  hooks: {
    onPostToolUse: async (input) => {
      if (typeof input.toolResult === "string") {
        let redacted = input.toolResult;
        for (const pattern of SENSITIVE_PATTERNS) {
          redacted = redacted.replace(
            pattern, "[REDACTED]"
          );
        }

        if (redacted !== input.toolResult) {
          return { modifiedResult: redacted };
        }
      }
      return null;
    },
  },
});

截断大型结果

const MAX_RESULT_LENGTH = 10000;

const session = await client.createSession({
  hooks: {
    onPostToolUse: async (input) => {
      const resultStr =
        JSON.stringify(input.toolResult);

      if (resultStr.length > MAX_RESULT_LENGTH) {
        return {
          modifiedResult: {
            truncated: true,
            originalLength: resultStr.length,
            content:
              resultStr.substring(
                0, MAX_RESULT_LENGTH
              ) + "...",
          },
          additionalContext:
            `Note: Result was truncated from `
            + `${resultStr.length} to `
            + `${MAX_RESULT_LENGTH} characters.`,
        };
      }
      return null;
    },
  },
});

基于结果添加上下文

const session = await client.createSession({
  hooks: {
    onPostToolUse: async (input) => {
      // If a file read returned an error,
      // add helpful context
      if (
        input.toolName === "read_file"
        && input.toolResult?.error
      ) {
        return {
          additionalContext:
            "Tip: If the file doesn't exist, "
            + "consider creating it or "
            + "checking the path.",
        };
      }

      // If shell command failed,
      // add debugging hint
      if (
        input.toolName === "shell"
        && input.toolResult?.exitCode !== 0
      ) {
        return {
          additionalContext:
            "The command failed. Check if "
            + "required dependencies are installed.",
        };
      }

      return null;
    },
  },
});

筛选错误堆栈跟踪

const session = await client.createSession({
  hooks: {
    onPostToolUse: async (input) => {
      if (input.toolResult?.error && input.toolResult?.stack) {
        // Remove internal stack trace details
        return {
          modifiedResult: {
            error: input.toolResult.error,
            // Keep only first 3 lines of stack
            stack: input.toolResult.stack.split("\n").slice(0, 3).join("\n"),
          },
        };
      }
      return null;
    },
  },
});

合规性审核线索

interface AuditEntry {
  timestamp: number;
  sessionId: string;
  toolName: string;
  args: unknown;
  result: unknown;
  success: boolean;
}

const auditLog: AuditEntry[] = [];

const session = await client.createSession({
  hooks: {
    onPostToolUse: async (input, invocation) => {
      auditLog.push({
        timestamp: input.timestamp,
        sessionId: invocation.sessionId,
        toolName: input.toolName,
        args: input.toolArgs,
        result: input.toolResult,
        success: !input.toolResult?.error,
      });

      // Optionally persist to database/file
      await saveAuditLog(auditLog);

      return null;
    },
  },
});

抑制噪声结果

const NOISY_TOOLS = ["list_directory", "search_codebase"];

const session = await client.createSession({
  hooks: {
    onPostToolUse: async (input) => {
      if (NOISY_TOOLS.includes(input.toolName)) {
        // Summarize instead of showing full result
        const items = Array.isArray(input.toolResult) 
          ? input.toolResult 
          : input.toolResult?.items || [];
        
        return {
          modifiedResult: {
            summary: `Found ${items.length} items`,
            firstFew: items.slice(0, 5),
          },
        };
      }
      return null;
    },
  },
});

最佳做法

        **无需更改时返回 `null` 。** 这比返回空对象或相同的结果更有效。

        **请谨慎修改结果。** 更改结果可能会影响模型解释工具输出的方式。 仅在必要时进行修改。

用additionalContext提示。添加上下文以帮助模型解释结果，而不是修改结果。

        **记录日志时请注意隐私。** 工具结果可能包含敏感数据。 在日志记录之前应用修订。

        **保持挂钩紧固。** 后工具挂钩同步运行。 应该以异步或批量的方式进行繁重的处理。

延伸阅读

        [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/quickstart)

        [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/pre-tool-use)

        [AUTOTITLE](/copilot/how-tos/copilot-sdk/use-hooks/error-handling)

谁可以使用此功能？

在本文中