mirror of
https://github.com/openai/codex.git
synced 2026-09-11 20:36:49 +00:00
cbfd999db7
## What changed - Add an `Interrupt` hook event that runs for an active top-level turn before its interrupted abort event is emitted. - Flush the turn transcript before invoking the hook and provide the session, turn, transcript, working directory, model, and permission mode in its input. - Support command and MCP handlers, including asynchronous commands, with a one-second default timeout and a three-second maximum. - Expose the event through hook configuration, managed requirements, app-server notifications, generated schemas, analytics, and the TUI hook views. ## Testing - Cover handler discovery, timeout normalization, output parsing, protocol compatibility, TUI rendering, and interrupt execution ordering. GitOrigin-RevId: 163fa7c098d94ac2775f6d137f8e916f8ea9b6eb
264 lines
5.7 KiB
JSON
Generated
264 lines
5.7 KiB
JSON
Generated
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"definitions": {
|
|
"AbsolutePathBuf": {
|
|
"description": "A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).\n\nIMPORTANT: When deserializing an `AbsolutePathBuf`, a base path must be set using [AbsolutePathBufGuard::new]. If no base path is set, the deserialization will fail unless the path being deserialized is already absolute.",
|
|
"type": "string"
|
|
},
|
|
"HookErrorInfo": {
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"path"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"HookEventName": {
|
|
"enum": [
|
|
"preToolUse",
|
|
"permissionRequest",
|
|
"postToolUse",
|
|
"preCompact",
|
|
"postCompact",
|
|
"sessionStart",
|
|
"sessionEnd",
|
|
"userPromptSubmit",
|
|
"subagentStart",
|
|
"subagentStop",
|
|
"stop",
|
|
"interrupt"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"HookMetadata": {
|
|
"oneOf": [
|
|
{
|
|
"properties": {
|
|
"async": {
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
"command": {
|
|
"type": "string"
|
|
},
|
|
"handlerType": {
|
|
"enum": [
|
|
"command"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"command",
|
|
"handlerType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"handlerType": {
|
|
"enum": [
|
|
"mcpTool"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"server": {
|
|
"type": "string"
|
|
},
|
|
"tool": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"handlerType",
|
|
"server",
|
|
"tool"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"handlerType": {
|
|
"enum": [
|
|
"prompt"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"handlerType"
|
|
],
|
|
"title": "PromptHookMetadata",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"handlerType": {
|
|
"enum": [
|
|
"agent"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"handlerType"
|
|
],
|
|
"title": "AgentHookMetadata",
|
|
"type": "object"
|
|
}
|
|
],
|
|
"properties": {
|
|
"additionalContextLimit": {
|
|
"description": "Configured `additionalContext` spill threshold. `null` uses 2,500 tokens; `0` disables spilling.",
|
|
"format": "uint",
|
|
"minimum": 0.0,
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"currentHash": {
|
|
"type": "string"
|
|
},
|
|
"displayOrder": {
|
|
"format": "int64",
|
|
"type": "integer"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"eventName": {
|
|
"$ref": "#/definitions/HookEventName"
|
|
},
|
|
"isManaged": {
|
|
"type": "boolean"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"matcher": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"pluginId": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"source": {
|
|
"$ref": "#/definitions/HookSource"
|
|
},
|
|
"sourcePath": {
|
|
"$ref": "#/definitions/AbsolutePathBuf"
|
|
},
|
|
"statusMessage": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"timeoutSec": {
|
|
"format": "uint64",
|
|
"minimum": 0.0,
|
|
"type": "integer"
|
|
},
|
|
"trustStatus": {
|
|
"$ref": "#/definitions/HookTrustStatus"
|
|
}
|
|
},
|
|
"required": [
|
|
"currentHash",
|
|
"displayOrder",
|
|
"enabled",
|
|
"eventName",
|
|
"isManaged",
|
|
"key",
|
|
"source",
|
|
"sourcePath",
|
|
"timeoutSec",
|
|
"trustStatus"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"HookSource": {
|
|
"enum": [
|
|
"system",
|
|
"user",
|
|
"project",
|
|
"mdm",
|
|
"sessionFlags",
|
|
"plugin",
|
|
"cloudRequirements",
|
|
"cloudManagedConfig",
|
|
"legacyManagedConfigFile",
|
|
"legacyManagedConfigMdm",
|
|
"unknown"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"HookTrustStatus": {
|
|
"enum": [
|
|
"managed",
|
|
"untrusted",
|
|
"trusted",
|
|
"modified"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"HooksListEntry": {
|
|
"properties": {
|
|
"cwd": {
|
|
"type": "string"
|
|
},
|
|
"errors": {
|
|
"items": {
|
|
"$ref": "#/definitions/HookErrorInfo"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"hooks": {
|
|
"items": {
|
|
"$ref": "#/definitions/HookMetadata"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"warnings": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"cwd",
|
|
"errors",
|
|
"hooks",
|
|
"warnings"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"properties": {
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/definitions/HooksListEntry"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"title": "HooksListResponse",
|
|
"type": "object"
|
|
} |