{"meta":{"title":"工具使用后挂钩","intro":"onPostToolUse 钩子会在工具成功执行后被调用。 使用它可执行以下操作：","product":"GitHub Copilot","breadcrumbs":[{"href":"/zh/copilot","title":"GitHub Copilot"},{"href":"/zh/copilot/how-tos","title":"操作方法"},{"href":"/zh/copilot/how-tos/copilot-sdk","title":"Copilot SDK"},{"href":"/zh/copilot/how-tos/copilot-sdk/hooks","title":"使用挂钩"},{"href":"/zh/copilot/how-tos/copilot-sdk/hooks/post-tool-use","title":"发布工具的使用"}],"documentType":"article"},"body":"# 工具使用后挂钩\n\nonPostToolUse 钩子会在工具成功执行后被调用。 使用它可执行以下操作：\n\n\n\n\n\n* 转换或筛选工具结果\n* 记录工具执行以用于审计\n* 基于结果添加上下文\n* 隐藏对话的结果\n\n> ```\n> **失败变体** — `onPostToolUse` 仅会在工具成功执行时触发。 若要查看**失败的**工具调用，请注册`onPostToolUseFailure`（在 Python 中为`on_post_tool_use_failure`，在 Go/.NET 中为`OnPostToolUseFailure`，在 Rust 中为`on_post_tool_use_failure`）。 处理程序接收 `{ sessionId, toolName, toolArgs, error, timestamp, workingDirectory }` - `error` 字段是从工具的失败结果中提取的字符串， 并可能返回 `{ additionalContext: string }` 为模型注入额外的指导（例如重试提示）。 有关完整列表，请参阅 [AUTOTITLE](/copilot/how-tos/copilot-sdk/hooks/hooks-overview) 。\n> ```\n\n\n\n## 挂钩签名\n\n
\n
TypeScript
\n\n```typescript\ntype PostToolUseHandler = (\n input: PostToolUseHookInput,\n invocation: HookInvocation,\n) => Promise;\n```\n\n
\n\n
Python
\n\n```python\nPostToolUseHandler = Callable[\n [PostToolUseHookInput, dict[str, str]],\n Awaitable[PostToolUseHookOutput | None]\n]\n```\n\n
\n\n
Go
\n\n```golang\ntype PostToolUseHandler func(\n input PostToolUseHookInput,\n invocation HookInvocation,\n) (*PostToolUseHookOutput, error)\n```\n\n
\n\n
.NET
\n\n```csharp\npublic delegate Task PostToolUseHandler(\n PostToolUseHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
Java
\n\n```java\n@FunctionalInterface\npublic interface PostToolUseHandler {\n CompletableFuture handle(\n PostToolUseHookInput input,\n HookInvocation invocation);\n}\n```\n\n
\n\n
\n\n## 输入\n\n| 领域 | 类型 | Description |\n| ------------------ | --------- | ----------- |\n| `timestamp` | SDK 时间戳类型 | 触发钩子时 |\n| `workingDirectory` | 字符串 | 当前工作目录 |\n| `toolName` | 字符串 | 已调用的工具的名称 |\n| `toolArgs` | 对象 | 传递给工具的参数 |\n| `toolResult` | 对象 | 工具返回的结果 |\n\n## 输出\n\n返回 `null` 或 `undefined` 传递结果不变。 否则，返回包含以下任何字段的对象：\n\n| 领域 | 类型 | Description |\n| ------------------- | ------- | -------------------- |\n| `modifiedResult` | 对象 | 要使用的修改结果，而不是原始结果 |\n| `additionalContext` | 字符串 | 向对话注入额外上下文 |\n| `suppressOutput` | boolean | 如果为 true，则结果不会显示在对话中 |\n\n## 示例\n\n### 记录所有工具结果\n\n
\n
TypeScript
\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input, invocation) => {\n console.log(`[${invocation.sessionId}] Tool: ${input.toolName}`);\n console.log(` Args: ${JSON.stringify(input.toolArgs)}`);\n console.log(` Result: ${JSON.stringify(input.toolResult)}`);\n return null; // Pass through unchanged\n },\n },\n});\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_post_tool_use(input_data, invocation):\n print(f\"[{invocation['session_id']}] Tool: {input_data['toolName']}\")\n print(f\" Args: {input_data['toolArgs']}\")\n print(f\" Result: {input_data['toolResult']}\")\n return None # Pass through unchanged\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_post_tool_use\": on_post_tool_use})\n```\n\n
\n\n
Go
\n\n```golang\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPostToolUse: func(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n fmt.Printf(\"[%s] Tool: %s\\n\", inv.SessionID, input.ToolName)\n fmt.Printf(\" Args: %v\\n\", input.ToolArgs)\n fmt.Printf(\" Result: %v\\n\", input.ToolResult)\n return nil, nil\n },\n },\n})\n```\n\n
\n\n
.NET
\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPostToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] Tool: {input.ToolName}\");\n Console.WriteLine($\" Args: {input.ToolArgs}\");\n Console.WriteLine($\" Result: {input.ToolResult}\");\n return Task.FromResult(null);\n },\n },\n});\n```\n\n
\n\n
Java
\n\n\n\n```java\nimport com.github.copilot.*;\nimport com.github.copilot.rpc.*;\nimport java.util.concurrent.CompletableFuture;\n\nvar hooks = new SessionHooks()\n .setOnPostToolUse((input, invocation) -> {\n System.out.println(\"[\" + invocation.getSessionId() + \"] Tool: \" + input.getToolName());\n System.out.println(\" Args: \" + input.getToolArgs());\n System.out.println(\" Result: \" + input.getToolResult());\n return CompletableFuture.completedFuture(null);\n });\n\nvar session = client.createSession(\n new SessionConfig()\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n .setHooks(hooks)\n).get();\n```\n\n
\n\n
\n\n### 对敏感数据进行修订\n\n```typescript\nconst SENSITIVE_PATTERNS = [\n /api[_-]?key[\"\\s:=]+[\"']?[\\w-]+[\"']?/gi,\n /password[\"\\s:=]+[\"']?[\\w-]+[\"']?/gi,\n /secret[\"\\s:=]+[\"']?[\\w-]+[\"']?/gi,\n];\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n if (typeof input.toolResult === \"string\") {\n let redacted = input.toolResult;\n for (const pattern of SENSITIVE_PATTERNS) {\n redacted = redacted.replace(pattern, \"[REDACTED]\");\n }\n\n if (redacted !== input.toolResult) {\n return { modifiedResult: redacted };\n }\n }\n return null;\n },\n },\n});\n```\n\n### 截断大型结果\n\n```typescript\nconst MAX_RESULT_LENGTH = 10000;\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n const resultStr = JSON.stringify(input.toolResult);\n\n if (resultStr.length > MAX_RESULT_LENGTH) {\n return {\n modifiedResult: {\n truncated: true,\n originalLength: resultStr.length,\n content: resultStr.substring(0, MAX_RESULT_LENGTH) + \"...\",\n },\n additionalContext: `Note: Result was truncated from ${resultStr.length} to ${MAX_RESULT_LENGTH} characters.`,\n };\n }\n return null;\n },\n },\n});\n```\n\n### 基于结果添加上下文\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n // If a file read returned an error, add helpful context\n if (input.toolName === \"read_file\" && input.toolResult?.error) {\n return {\n additionalContext:\n \"Tip: If the file doesn't exist, consider creating it or checking the path.\",\n };\n }\n\n // If shell command failed, add debugging hint\n if (input.toolName === \"shell\" && input.toolResult?.exitCode !== 0) {\n return {\n additionalContext:\n \"The command failed. Check if required dependencies are installed.\",\n };\n }\n\n return null;\n },\n },\n});\n```\n\n### 筛选错误堆栈跟踪\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n if (input.toolResult?.error && input.toolResult?.stack) {\n // Remove internal stack trace details\n return {\n modifiedResult: {\n error: input.toolResult.error,\n // Keep only first 3 lines of stack\n stack: input.toolResult.stack.split(\"\\n\").slice(0, 3).join(\"\\n\"),\n },\n };\n }\n return null;\n },\n },\n});\n```\n\n### 合规性审核线索\n\n```typescript\ninterface AuditEntry {\n timestamp: Date;\n sessionId: string;\n toolName: string;\n args: unknown;\n result: unknown;\n success: boolean;\n}\n\nconst auditLog: AuditEntry[] = [];\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input, invocation) => {\n auditLog.push({\n timestamp: input.timestamp,\n sessionId: invocation.sessionId,\n toolName: input.toolName,\n args: input.toolArgs,\n result: input.toolResult,\n success: !input.toolResult?.error,\n });\n\n // Optionally persist to database/file\n await saveAuditLog(auditLog);\n\n return null;\n },\n },\n});\n```\n\n### 抑制嘈杂结果\n\n```typescript\nconst NOISY_TOOLS = [\"list_directory\", \"search_codebase\"];\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n if (NOISY_TOOLS.includes(input.toolName)) {\n // Summarize instead of showing full result\n const items = Array.isArray(input.toolResult)\n ? input.toolResult\n : input.toolResult?.items || [];\n\n return {\n modifiedResult: {\n summary: `Found ${items.length} items`,\n firstFew: items.slice(0, 5),\n },\n };\n }\n return null;\n },\n },\n});\n```\n\n## 最佳做法\n\n1. **无需更改时返回 `null`** - 这比返回空对象或相同的结果更有效。\n\n2. **谨慎修改结果** - 更改结果可能会影响模型对工具输出的解释方式。 仅在必要时进行修改。\n\n3. **使用 `additionalContext` 提供提示** - 不要修改结果，而是添加上下文以帮助模型理解这些结果。\n\n4. **日志记录时考虑隐私** - 工具结果可能包含敏感数据。 在记录前应用编辑。\n\n5. **保持钩子快速** - 后置工具钩子会同步运行。 应该以异步或批量的方式进行繁重的处理。\n\n## 另见\n\n* [使用挂钩](/zh/copilot/how-tos/copilot-sdk/hooks)\n* [工具使用前挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/pre-tool-use)\n* [错误处理挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/error-handling)"}