{"meta":{"title":"会话挂钩","intro":"钩子允许你在对话生命周期的关键节点拦截并自定义 Copilot 会话的行为。 使用挂钩可以：","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/hooks-overview","title":"挂钩概述"}],"documentType":"article"},"body":"# 会话挂钩\n\n钩子允许你在对话生命周期的关键节点拦截并自定义 Copilot 会话的行为。 使用挂钩可以：\n\n\n\n\n\n* **控制工具执行** - 批准、拒绝或修改工具调用\n* **转换结果** - 在处理结果之前修改工具输出\n* **添加上下文** - 在会话开始时注入其他信息\n* **处理错误** - 实现自定义错误处理\n* **审核和记录** - 跟踪符合性的所有交互\n\n## 可用挂钩\n\n| 挂钩 | Trigger | 用例 |\n| --------------------------------------------------------------------------------- | ------------ | ------------- |\n| [工具使用前挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/pre-tool-use) | 在工具执行之前 | 权限控制，参数验证 |\n| [工具使用后挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/post-tool-use) | 工具执行后（仅在成功时） | 结果转换，日志记录 |\n| [工具使用后挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/post-tool-use#failure-variant) | 在工具执行结果为失败之后 | 添加重试指引，记录失败日志 |\n| [用户提示提交挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/user-prompt-submitted) | 当用户发送消息时 | 提示修改、筛选 |\n| [用户提示转换钩子](/zh/copilot/how-tos/copilot-sdk/hooks/user-prompt-transformed) | 运行时提示转换后 | 检查或替换面向模型的内容 |\n| [会话生命周期挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#session-start) | 会话开始 | 添加上下文，配置会话 |\n| [会话生命周期挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#session-end) | 会话结束 | 清理、分析 |\n| [错误处理挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/error-handling) | 发生错误 | 自定义错误处理 |\n| [会话生命周期挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#agent-stop) | 顶级智能体自然停止 | 确认完成或请求另一轮 |\n\n## 快速入门\n\n
\n
TypeScript
\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n console.log(`Tool called: ${input.toolName}`);\n // Allow all tools\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input) => {\n console.log(`Tool result: ${JSON.stringify(input.toolResult)}`);\n return null; // No modifications\n },\n onSessionStart: async (input) => {\n return { additionalContext: \"User prefers concise answers.\" };\n },\n },\n});\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n async def on_pre_tool_use(input_data, invocation):\n print(f\"Tool called: {input_data['toolName']}\")\n return {\"permissionDecision\": \"allow\"}\n\n async def on_post_tool_use(input_data, invocation):\n print(f\"Tool result: {input_data['toolResult']}\")\n return None\n\n async def on_session_start(input_data, invocation):\n return {\"additionalContext\": \"User prefers concise answers.\"}\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n \"on_session_start\": on_session_start,\n })\n```\n\n
\n\n
Go
\n\n```golang\npackage main\n\nimport (\n \"context\"\n \"fmt\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n client := copilot.NewClient(nil)\n\n session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n fmt.Printf(\"Tool called: %s\\n\", input.ToolName)\n return &copilot.PreToolUseHookOutput{\n PermissionDecision: \"allow\",\n }, nil\n },\n OnPostToolUse: func(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n fmt.Printf(\"Tool result: %v\\n\", input.ToolResult)\n return nil, nil\n },\n OnSessionStart: func(input copilot.SessionStartHookInput, inv copilot.HookInvocation) (*copilot.SessionStartHookOutput, error) {\n return &copilot.SessionStartHookOutput{\n AdditionalContext: \"User prefers concise answers.\",\n }, nil\n },\n },\n })\n _ = session\n}\n```\n\n
\n\n
.NET
\n\n```csharp\nusing GitHub.Copilot;\n\nvar client = new CopilotClient();\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"Tool called: {input.ToolName}\");\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" }\n );\n },\n OnPostToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"Tool result: {input.ToolResult}\");\n return Task.FromResult(null);\n },\n OnSessionStart = (input, invocation) =>\n {\n return Task.FromResult(\n new SessionStartHookOutput { AdditionalContext = \"User prefers concise answers.\" }\n );\n },\n },\n});\n```\n\n
\n\n
Java
\n\n```java\nimport com.github.copilot.*;\nimport com.github.copilot.rpc.*;\nimport java.util.concurrent.CompletableFuture;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var hooks = new SessionHooks()\n .setOnPreToolUse((input, invocation) -> {\n System.out.println(\"Tool called: \" + input.getToolName());\n return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());\n })\n .setOnPostToolUse((input, invocation) -> {\n System.out.println(\"Tool result: \" + input.getToolResult());\n return CompletableFuture.completedFuture(null);\n })\n .setOnSessionStart((input, invocation) -> {\n return CompletableFuture.completedFuture(\n new SessionStartHookOutput(\"User prefers concise answers.\", null)\n );\n });\n\n var session = client.createSession(\n new SessionConfig()\n .setHooks(hooks)\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n}\n```\n\n
\n\n
\n\n## 挂钩调用上下文\n\n每个挂钩接收一个 `invocation` 参数，其中包含有关当前会话的上下文：\n\n| 领域 | 类型 | 说明 |\n| ----------- | --- | -------- |\n| `sessionId` | 字符串 | 当前会话的 ID |\n\n这允许钩子维护状态或执行会话特定的逻辑。\n\n## 常见模式\n\n### 记录所有工具调用\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n console.log(`[${new Date().toISOString()}] Tool: ${input.toolName}, Args: ${JSON.stringify(input.toolArgs)}`);\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input) => {\n console.log(`[${new Date().toISOString()}] Result: ${JSON.stringify(input.toolResult)}`);\n return null;\n },\n },\n});\n```\n\n### 阻止危险工具\n\n```typescript\nconst BLOCKED_TOOLS = [\"shell\", \"bash\", \"exec\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (BLOCKED_TOOLS.includes(input.toolName)) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: \"Shell access is not permitted\",\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### 添加用户上下文\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async () => {\n const userPrefs = await loadUserPreferences();\n return {\n additionalContext: `User preferences: ${JSON.stringify(userPrefs)}`,\n };\n },\n },\n});\n```\n\n## 挂钩指南\n\n* **[工具使用前挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/pre-tool-use)** - 控制工具执行权限\n* **[工具使用后挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/post-tool-use)** - 转换工具结果\n* **[用户提示提交挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/user-prompt-submitted)** - 修改用户提示\n* **[用户提示转换钩子](/zh/copilot/how-tos/copilot-sdk/hooks/user-prompt-transformed)** - 替换面向模型的提示\n* **[会话生命周期挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/session-lifecycle)** - 会话开始和结束\n* **[会话生命周期挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/session-lifecycle#agent-stop)** - 在代理停止之前验证完成\n* **[错误处理挂钩](/zh/copilot/how-tos/copilot-sdk/hooks/error-handling)** - 自定义错误处理\n\n## 另见\n\n* [构建你的第一个由 Copilot 提供支持的应用](/zh/copilot/how-tos/copilot-sdk/getting-started)\n* [构建你的第一个由 Copilot 提供支持的应用](/zh/copilot/how-tos/copilot-sdk/getting-started#step-4-add-a-custom-tool)\n* [调试指南](/zh/copilot/how-tos/copilot-sdk/troubleshooting/debugging)"}