Re-exports§
pub use rpc::*;
Modules§
- rpc
- We do not do true JSON-RPC 2.0, as we neither send nor expect the “jsonrpc”: “2.0” field.
Structs§
- Account
Login Completed Notification - Account
Rate Limits Updated Notification - Sparse rolling rate-limit update.
- Account
Session - Account
Session Workspace - Account
Sessions AddParams - Account
Sessions List Params - Account
Sessions Logout Params - Account
Sessions Response - Account
Sessions Switch Params - Account
Token Usage Daily Bucket - Account
Token Usage Summary - Account
Updated Notification - Active
Permission Profile - Additional
Context Entry - Additional
File System Permissions - Additional
Network Permissions - Additional
Permission Profile - Agent
Message Delta Notification - Analytics
Config - AppBranding
- EXPERIMENTAL - app metadata returned by app-list APIs.
- AppConfig
- AppInfo
- EXPERIMENTAL - app metadata returned by app-list APIs.
- AppList
Updated Notification - EXPERIMENTAL - notification emitted when the app list changes.
- AppMetadata
- AppReview
- AppScreenshot
- AppSummary
- EXPERIMENTAL - app metadata summary for plugin responses.
- AppTemplate
Summary - AppTool
Config - AppTool
Summary - EXPERIMENTAL - metadata returned by app/read.
- AppTools
Config - Apply
Patch Approval Params - Apply
Patch Approval Response - Apps
Config - Apps
Default Config - Apps
Installed Params - Read the committed installed connector runtime snapshot.
- Apps
Installed Response - The installed connectors in one committed runtime snapshot.
- Apps
List Params - EXPERIMENTAL - list available apps/connectors.
- Apps
List Response - EXPERIMENTAL - app list response.
- Apps
Read Params - EXPERIMENTAL - read metadata for specific apps/connectors.
- Apps
Read Response - EXPERIMENTAL - app/read response.
- Attestation
Generate Params - Attestation
Generate Response - Byte
Range - Cancel
Login Account Params - Cancel
Login Account Response - Chatgpt
Auth Tokens Refresh Params - Chatgpt
Auth Tokens Refresh Response - Client
Info - Collab
Agent State - Collaboration
Mode List Params - EXPERIMENTAL - list collaboration mode presets.
- Collaboration
Mode List Response - EXPERIMENTAL - collaboration mode presets response.
- Collaboration
Mode Mask - EXPERIMENTAL - collaboration mode preset metadata for clients.
- Command
Exec Output Delta Notification - Base64-encoded output chunk emitted for a streaming
command/execrequest. - Command
Exec Params - Run a standalone command (argv vector) in the server sandbox without creating a thread or turn.
- Command
Exec Resize Params - Resize a running PTY-backed
command/execsession. - Command
Exec Resize Response - Empty success response for
command/exec/resize. - Command
Exec Response - Final buffered result for
command/exec. - Command
Exec Terminal Size - PTY size in character cells for
command/execPTY sessions. - Command
Exec Terminate Params - Terminate a running
command/execsession. - Command
Exec Terminate Response - Empty success response for
command/exec/terminate. - Command
Exec Write Params - Write stdin bytes to a running
command/execsession, close stdin, or both. - Command
Exec Write Response - Empty success response for
command/exec/write. - Command
Execution Output Delta Notification - Command
Execution Request Approval Params - Command
Execution Request Approval Response - Command
Migration - Computer
UseRequirements - Config
- Config
Batch Write Params - Config
Edit - Config
Layer - Config
Layer Metadata - Config
Read Params - Config
Read Response - Config
Requirements - Config
Requirements Read Response - Config
Value Write Params - Config
Warning Notification - Config
Write Response - Configured
Hook Matcher Group - Connector
Metadata - EXPERIMENTAL - metadata returned by app/read.
- Consume
Account Rate Limit Reset Credit Params - Consume
Account Rate Limit Reset Credit Response - Context
Compacted Notification - Deprecated: Use
ContextCompactionitem type instead. - Conversation
GitInfo - Conversation
Summary - Credits
Snapshot - Current
Time Read Params - Current
Time Read Response - Deprecation
Notice Notification - Dynamic
Tool Call Params - Dynamic
Tool Call Response - Dynamic
Tool Function Spec - Dynamic
Tool Namespace Spec - Environment
AddParams - Environment
AddResponse - Environment
Connection Notification - Environment
Info Params - Environment
Info Response - Environment
Shell Info - Environment
Status Params - Parameters for reading the current status of one configured environment.
- Environment
Status Response - Current status for the requested environment.
- Error
Notification - Exec
Command Approval Params - Exec
Command Approval Response - Exec
Policy Amendment - Experimental
Feature - Experimental
Feature Enablement SetParams - Experimental
Feature Enablement SetResponse - Experimental
Feature List Params - Experimental
Feature List Response - Experimental
Field - Describes an experimental field on a specific type.
- External
Agent Config Detect Params - External
Agent Config Detect Response - External
Agent Config Import Completed Notification - External
Agent Config Import Histories Read Response - External
Agent Config Import History - External
Agent Config Import Item Type Failure - External
Agent Config Import Item Type Success - External
Agent Config Import Params - External
Agent Config Import Progress Notification - External
Agent Config Import Response - External
Agent Config Import Type Result - External
Agent Config Migration Item - External
Agent Imported Connector Candidate - Feedback
Requirements - Feedback
Upload Params - Feedback
Upload Response - File
Change Output Delta Notification - Deprecated legacy notification for
apply_patchtextual output. - File
Change Patch Updated Notification - File
Change Request Approval Params - File
Change Request Approval Response - File
System Sandbox Entry - File
Update Change - FsChanged
Notification - Filesystem watch notification emitted for
fs/watchsubscribers. - FsCopy
Params - Copy a file or directory tree on the host filesystem.
- FsCopy
Response - Successful response for
fs/copy. - FsCreate
Directory Params - Create a directory on the host filesystem.
- FsCreate
Directory Response - Successful response for
fs/createDirectory. - FsGet
Metadata Params - Request metadata for an absolute path.
- FsGet
Metadata Response - Metadata returned by
fs/getMetadata. - FsRead
Directory Entry - A directory entry returned by
fs/readDirectory. - FsRead
Directory Params - List direct child names for a directory.
- FsRead
Directory Response - Directory entries returned by
fs/readDirectory. - FsRead
File Params - Read a file from the host filesystem.
- FsRead
File Response - Base64-encoded file contents returned by
fs/readFile. - FsRemove
Params - Remove a file or directory tree from the host filesystem.
- FsRemove
Response - Successful response for
fs/remove. - FsUnwatch
Params - Stop filesystem watch notifications for a prior
fs/watch. - FsUnwatch
Response - Successful response for
fs/unwatch. - FsWatch
Params - Start filesystem watch notifications for an absolute path.
- FsWatch
Response - Successful response for
fs/watch. - FsWrite
File Params - Write a file on the host filesystem.
- FsWrite
File Response - Successful response for
fs/writeFile. - Fuzzy
File Search Params - Fuzzy
File Search Response - Fuzzy
File Search Result - Superset of [
codex_file_search::FileMatch] - Fuzzy
File Search Session Completed Notification - Fuzzy
File Search Session Start Params - Fuzzy
File Search Session Start Response - Fuzzy
File Search Session Stop Params - Fuzzy
File Search Session Stop Response - Fuzzy
File Search Session Update Params - Fuzzy
File Search Session Update Response - Fuzzy
File Search Session Updated Notification - Generate
TsOptions - GetAccount
Params - GetAccount
Rate Limits Response - GetAccount
Response - GetAccount
Token Usage Response - GetAuth
Status Params - GetAuth
Status Response - GetConversation
Summary Response - GetWorkspace
Messages Response - GitDiff
ToRemote Params - GitDiff
ToRemote Response - GitInfo
- GitSha
- Granted
Permission Profile - Guardian
Apply Patch Review Action - Guardian
Approval Review - [UNSTABLE] Temporary approval auto-review payload used by
item/autoApprovalReview/*notifications. This shape is expected to change soon. - Guardian
Command Review Action - Guardian
Execve Review Action - Guardian
McpTool Call Review Action - Guardian
Network Access Review Action - Guardian
Request Permissions Review Action - Guardian
Warning Notification - Hook
Completed Notification - Hook
Error Info - Hook
Metadata - Hook
Migration - Hook
Output Entry - Hook
Prompt Fragment - Hook
RunSummary - Hook
Started Notification - Hooks
List Entry - Hooks
List Params - Hooks
List Response - Image
Generation Item - Initialize
Capabilities - Client-declared capabilities negotiated during initialize.
- Initialize
Params - Initialize
Response - Installed
App - Installed connector runtime state.
- Interrupt
Conversation Response - Item
Completed Notification - Item
Guardian Approval Review Completed Notification - [UNSTABLE] Temporary notification payload for approval auto-review. This shape is expected to change soon.
- Item
Guardian Approval Review Started Notification - [UNSTABLE] Temporary notification payload for approval auto-review. This shape is expected to change soon.
- Item
Started Notification - List
McpServer Status Params - List
McpServer Status Response - Login
ApiKey Params - Logout
Account Response - Managed
Hooks Requirements - Marketplace
AddParams - Marketplace
AddResponse - Marketplace
Interface - Marketplace
Load Error Info - Marketplace
Remove Params - Marketplace
Remove Response - Marketplace
Upgrade Error Info - Marketplace
Upgrade Params - Marketplace
Upgrade Response - McpElicitation
Boolean Schema - McpElicitation
Const Option - McpElicitation
Legacy Titled Enum Schema - McpElicitation
Number Schema - McpElicitation
Schema - Typed form schema for MCP
elicitation/createrequests. - McpElicitation
String Schema - McpElicitation
Titled Enum Items - McpElicitation
Titled Multi Select Enum Schema - McpElicitation
Titled Single Select Enum Schema - McpElicitation
Untitled Enum Items - McpElicitation
Untitled Multi Select Enum Schema - McpElicitation
Untitled Single Select Enum Schema - McpResource
Read Params - McpResource
Read Response - McpServer
Elicitation Request Params - McpServer
Elicitation Request Response - McpServer
Migration - McpServer
Oauth Login Completed Notification - McpServer
Oauth Login Params - McpServer
Oauth Login Response - McpServer
Refresh Params - McpServer
Refresh Response - McpServer
Status - McpServer
Status Updated Notification - McpServer
Tool Call Params - McpServer
Tool Call Response - McpTool
Call AppContext - McpTool
Call Error - McpTool
Call Progress Notification - McpTool
Call Result - Memory
Citation - Memory
Citation Entry - Memory
Reset Response - Migration
Details - Mock
Experimental Method Params - Mock
Experimental Method Response - Model
- Model
Availability Nux - Model
List Params - Model
List Response - Model
Provider Capabilities Read Params - Model
Provider Capabilities Read Response - Model
Rerouted Notification - Model
Safety Buffering Updated Notification - Model
Service Tier - Model
Upgrade Info - Model
Verification Notification - Models
Requirements - Network
Approval Context - Network
Policy Amendment - Network
Requirements - NewThread
Model Defaults - Overridden
Metadata - Permission
Profile List Params - Permission
Profile List Response - Permission
Profile Summary - Permissions
Request Approval Params - Permissions
Request Approval Response - Plan
Delta Notification - EXPERIMENTAL - proposed plan streaming deltas for plan items. Clients should not assume concatenated deltas match the completed plan item content.
- Plugin
Detail - Plugin
Hook Summary - Plugin
Install Params - Plugin
Install Response - Plugin
Installed Params - Plugin
Installed Response - Plugin
Interface - Plugin
List Params - Plugin
List Response - Plugin
Marketplace Entry - Plugin
Read Params - Plugin
Read Response - Plugin
Share Checkout Params - Plugin
Share Checkout Response - Plugin
Share Context - Plugin
Share Delete Params - Plugin
Share Delete Response - Plugin
Share List Item - Plugin
Share List Params - Plugin
Share List Response - Plugin
Share Principal - Plugin
Share Save Params - Plugin
Share Save Response - Plugin
Share Target - Plugin
Share Update Targets Params - Plugin
Share Update Targets Response - Plugin
Skill Read Params - Plugin
Skill Read Response - Plugin
Summary - Plugin
Uninstall Params - Plugin
Uninstall Response - Plugins
Migration - Process
Exited Notification - Final process exit notification for
process/spawn. - Process
Kill Params - Terminate a running
process/spawnsession. - Process
Kill Response - Empty success response for
process/kill. - Process
Output Delta Notification - Base64-encoded output chunk emitted for a streaming
process/spawnrequest. - Process
Resize PtyParams - Resize a running PTY-backed
process/spawnsession. - Process
Resize PtyResponse - Empty success response for
process/resizePty. - Process
Spawn Params - Spawn a standalone process (argv vector) without a Codex sandbox on the host where the app server is running.
- Process
Spawn Response - Successful response for
process/spawn. - Process
Terminal Size - PTY size in character cells for
process/spawnPTY sessions. - Process
Write Stdin Params - Write stdin bytes to a running
process/spawnsession, close stdin, or both. - Process
Write Stdin Response - Empty success response for
process/writeStdin. - Rate
Limit Reset Credit - Rate
Limit Reset Credits Summary - Rate
Limit Snapshot - Rate
Limit Window - RawResponse
Completed Notification - Internal-only notification containing the exact usage from one upstream Responses API completion.
- RawResponse
Item Completed Notification - Reasoning
Effort Option - Reasoning
Summary Part Added Notification - Reasoning
Summary Text Delta Notification - Reasoning
Text Delta Notification - Remote
Control Client - Remote
Control Clients List Params - Remote
Control Clients List Response - Remote
Control Clients Revoke Params - Remote
Control Clients Revoke Response - Remote
Control Disable Params - Remote
Control Disable Response - Remote
Control Enable Params - Remote
Control Enable Response - Remote
Control Pairing Start Params - Remote
Control Pairing Start Response - Remote
Control Pairing Status Params - Remote
Control Pairing Status Response - Remote
Control Status Changed Notification - Current remote-control connection status and remote identity exposed to clients.
- Remote
Control Status Read Response - Request
Permission Profile - Review
Start Params - Review
Start Response - Sandbox
Settings - Sandbox
Workspace Write - Scheduled
Task Summary - Schema
Fixture Options - Selected
Capability Root - A user-selected root that can expose one or more runtime capabilities.
- Send
AddCredits Nudge Email Params - Send
AddCredits Nudge Email Response - Server
Notification Envelope - Server notification envelope sent over app-server transports.
- Server
Request Resolved Notification - Session
Migration - Skill
Dependencies - Skill
Error Info - Skill
Interface - Skill
Metadata - Skill
Migration - Skill
Summary - Skill
Tool Dependency - Skills
Changed Notification - Notification emitted when watched local skill files change.
- Skills
Config Write Params - Skills
Config Write Response - Skills
Extra Roots SetParams - Skills
Extra Roots SetResponse - Skills
List Entry - Skills
List Params - Skills
List Response - Sleep
Item - Display item emitted by the interruptible
clock.sleeptool. - Spend
Control Limit Snapshot - Subagent
Migration - Terminal
Interaction Notification - Text
Element - Text
Position - Text
Range - Thread
- Thread
Approve Guardian Denied Action Params - Thread
Approve Guardian Denied Action Response - Thread
Archive Params - Thread
Archive Response - Thread
Archived Notification - Thread
Background Terminal - Thread
Background Terminals Clean Params - Thread
Background Terminals Clean Response - Thread
Background Terminals List Params - Thread
Background Terminals List Response - Thread
Background Terminals Terminate Params - Thread
Background Terminals Terminate Response - Thread
Closed Notification - Thread
Compact Start Params - Thread
Compact Start Response - Thread
Decrement Elicitation Params - Parameters for
thread/decrement_elicitation. - Thread
Decrement Elicitation Response - Response for
thread/decrement_elicitation. - Thread
Delete Params - Thread
Delete Response - Thread
Deleted Notification - Thread
Extra - Extra app-server data for a thread.
- Thread
Fork Params - There are two ways to fork a thread:
- Thread
Fork Response - Thread
Goal - Thread
Goal Clear Params - Thread
Goal Clear Response - Thread
Goal Cleared Notification - Thread
Goal GetParams - Thread
Goal GetResponse - Thread
Goal SetParams - Thread
Goal SetResponse - Thread
Goal Updated Notification - Thread
History Builder - Thread
History Change Set - Incremental changes produced by opt-in
ThreadHistoryBuilderhandlers. - Thread
History Item Change - A materialized
ThreadItemsnapshot that changed while handling one input. - Thread
History Turn Change - Lightweight turn metadata snapshot for projectors that track turn status without re-reading the full item list.
- Thread
Increment Elicitation Params - Parameters for
thread/increment_elicitation. - Thread
Increment Elicitation Response - Response for
thread/increment_elicitation. - Thread
Inject Items Params - Thread
Inject Items Response - Thread
Item Entry - Thread
Items List Params - Thread
Items List Response - Thread
List Params - Thread
List Response - Thread
Loaded List Params - Thread
Loaded List Response - Thread
Memory Mode SetParams - Thread
Memory Mode SetResponse - Thread
Metadata GitInfo Update Params - Thread
Metadata Update Params - Thread
Metadata Update Response - Thread
Name Updated Notification - Thread
Read Params - Thread
Read Response - Thread
Realtime Append Audio Params - EXPERIMENTAL - append audio input to thread realtime.
- Thread
Realtime Append Audio Response - EXPERIMENTAL - response for appending realtime audio input.
- Thread
Realtime Append Speech Params - EXPERIMENTAL - append speakable text to thread realtime.
- Thread
Realtime Append Speech Response - EXPERIMENTAL - response for appending realtime speech.
- Thread
Realtime Append Text Params - EXPERIMENTAL - append text input to thread realtime.
- Thread
Realtime Append Text Response - EXPERIMENTAL - response for appending realtime text input.
- Thread
Realtime Audio Chunk - EXPERIMENTAL - thread realtime audio chunk.
- Thread
Realtime Closed Notification - EXPERIMENTAL - emitted when thread realtime transport closes.
- Thread
Realtime Error Notification - EXPERIMENTAL - emitted when thread realtime encounters an error.
- Thread
Realtime Initial Item - EXPERIMENTAL - role-bearing text item included when a realtime V3 session starts.
- Thread
Realtime Item Added Notification - EXPERIMENTAL - raw non-audio thread realtime item emitted by the backend.
- Thread
Realtime List Voices Params - EXPERIMENTAL - list voices supported by thread realtime.
- Thread
Realtime List Voices Response - EXPERIMENTAL - response for listing supported realtime voices.
- Thread
Realtime Output Audio Delta Notification - EXPERIMENTAL - streamed output audio emitted by thread realtime.
- Thread
Realtime SdpNotification - EXPERIMENTAL - emitted with the remote SDP for a WebRTC realtime session.
- Thread
Realtime Start Params - EXPERIMENTAL - start a thread-scoped realtime session.
- Thread
Realtime Start Response - EXPERIMENTAL - response for starting thread realtime.
- Thread
Realtime Started Notification - EXPERIMENTAL - emitted when thread realtime startup is accepted.
- Thread
Realtime Stop Params - EXPERIMENTAL - stop thread realtime.
- Thread
Realtime Stop Response - EXPERIMENTAL - response for stopping thread realtime.
- Thread
Realtime Transcript Delta Notification - EXPERIMENTAL - flat transcript delta emitted whenever realtime transcript text changes.
- Thread
Realtime Transcript Done Notification - EXPERIMENTAL - final transcript text emitted when realtime completes a transcript part.
- Thread
Resume Initial Turns Page Params - Thread
Resume Params - There are three ways to resume a thread:
- Thread
Resume Response - Thread
Rollback Params - DEPRECATED:
thread/rollbackwill be removed soon. - Thread
Rollback Response - Thread
Search Occurrence - One visible message occurrence returned by
ThreadSearchOccurrencesResponse. - Thread
Search Occurrences Params - Parameters for searching visible message occurrences within one paginated thread.
- Thread
Search Occurrences Response - Thread
Search Params - Thread
Search Response - Thread
Search Result - Thread
Search Text Range - UTF-16 code-unit range within
snippet. - Thread
SetName Params - Thread
SetName Response - Thread
Settings - Thread
Settings Update Params - Thread
Settings Update Response - Thread
Settings Updated Notification - Thread
Shell Command Params - Thread
Shell Command Response - Thread
Start Params - Thread
Start Response - Thread
Started Notification - Thread
Status Changed Notification - Thread
Token Usage - Thread
Token Usage Updated Notification - Thread
Turns List Params - Thread
Turns List Response - Thread
Unarchive Params - Thread
Unarchive Response - Thread
Unarchived Notification - Thread
Unsubscribe Params - Thread
Unsubscribe Response - Token
Usage Breakdown - Tool
Request User Input Answer - EXPERIMENTAL. Captures a user’s answer to a request_user_input question.
- Tool
Request User Input Option - EXPERIMENTAL. Defines a single selectable option for request_user_input.
- Tool
Request User Input Params - EXPERIMENTAL. Params sent with a request_user_input event.
- Tool
Request User Input Question - EXPERIMENTAL. Represents one request_user_input question and its required options.
- Tool
Request User Input Response - EXPERIMENTAL. Response payload mapping question ids to answers.
- Tools
- ToolsV2
- Turn
- Turn
Completed Notification - Turn
Diff Updated Notification - Notification that the turn-level unified diff has changed. Contains the latest aggregated diff across all file changes in the turn.
- Turn
Environment Params - Turn
Error - Turn
Interrupt Params - Turn
Interrupt Response - Turn
Moderation Metadata Notification - Turn
Plan Step - Turn
Plan Updated Notification - Turn
Start Params - Turn
Start Response - Turn
Started Notification - Turn
Steer Params - Turn
Steer Response - Turns
Page - Usage
- User
Saved Config - Warning
Notification - WebSearch
Item - Windows
Sandbox Readiness Response - Windows
Sandbox Setup Completed Notification - Windows
Sandbox Setup Start Params - Windows
Sandbox Setup Start Response - Windows
World Writable Warning Notification - Workspace
Message
Enums§
- Account
- Account
Session Workspace Kind - AddCredits
Nudge Credit Type - AddCredits
Nudge Email Status - Additional
Context Kind - AppTemplate
Unavailable Reason - AppTool
Approval - Approvals
Reviewer - Configures who approval requests are routed to for review. Examples
include sandbox escapes, blocked network access, MCP approval prompts, and
ARC escalations. Defaults to
user.auto_reviewuses a carefully prompted subagent to gather relevant context and apply a risk-based decision framework before approving or denying the request. - AskFor
Approval - Auth
Mode - Authentication mode for OpenAI-backed providers.
- Auto
Review Decision Source - [UNSTABLE] Source that produced a terminal approval auto-review decision.
- Cancel
Login Account Status - Capability
Root Location - Location used to resolve a selected capability root.
- Chatgpt
Auth Tokens Refresh Reason - Client
Notification - Client
Request - Request from the client to the server.
- Client
Request Serialization Scope - Client
Response - Typed response from the server to the client.
- Client
Response Payload - Codex
Error Info - This translation layer make sure that we expose codex error code in camel case.
- Collab
Agent Status - Collab
Agent Tool - Collab
Agent Tool Call Status - Command
Action - Command
Exec Output Stream - Stream label for
command/exec/outputDeltanotifications. - Command
Execution Approval Decision - Command
Execution Source - Command
Execution Status - Config
Layer Source - Config
Write Error Code - Configured
Hook Handler - Consume
Account Rate Limit Reset Credit Outcome - Dynamic
Tool Call Output Content Item - Dynamic
Tool Call Status - Dynamic
Tool Namespace Tool - Dynamic
Tool Spec - Environment
Status Kind - Current status observed by app-server without starting or recovering an environment.
- Experimental
Feature Stage - External
Agent Config Migration Item Type - External
Agent Imported Connector Source - File
Change Approval Decision - File
System Access Mode - File
System Path - File
System Special Path - Forced
Chatgpt Workspace Ids - Backward-compatible API shape for ChatGPT workspace login restrictions.
- Fuzzy
File Search Match Type - GetConversation
Summary Params - Guardian
Approval Review Action - Guardian
Approval Review Status - [UNSTABLE] Lifecycle state for an approval auto-review.
- Guardian
Command Source - Guardian
Risk Level - [UNSTABLE] Risk level assigned by approval auto-review.
- Guardian
User Authorization - [UNSTABLE] Authorization level assigned by approval auto-review.
- Hook
Event Name - Hook
Execution Mode - Hook
Handler Type - Hook
Output Entry Kind - Hook
RunStatus - Hook
Scope - Hook
Source - Hook
Trust Status - Login
Account Params - Login
Account Response - Login
AppBrand - McpAuth
Status - McpElicitation
Array Type - McpElicitation
Boolean Type - McpElicitation
Enum Schema - McpElicitation
Multi Select Enum Schema - McpElicitation
Number Type - McpElicitation
Object Type - McpElicitation
Primitive Schema - McpElicitation
Single Select Enum Schema - McpElicitation
String Format - McpElicitation
String Type - McpResource
Content - Contents returned when reading a resource from an MCP server.
- McpServer
Elicitation Action - McpServer
Elicitation Request - McpServer
Startup Failure Reason - McpServer
Startup State - McpServer
Status Detail - McpTool
Call Status - Merge
Strategy - Model
Reroute Reason - Model
Verification - Network
Access - Network
Approval Protocol - Network
Domain Permission - Network
Policy Rule Action - Network
Unix Socket Permission - NonSteerable
Turn Kind - Patch
Apply Status - Patch
Change Kind - Permission
Grant Scope - Plugin
Auth Policy - Plugin
Availability - Plugin
Install Policy - Plugin
Install Policy Source - Plugin
List Marketplace Kind - Plugin
Share Discoverability - Plugin
Share Principal Role - Plugin
Share Principal Type - Plugin
Share Target Role - Plugin
Share Update Discoverability - Plugin
Source - Process
Output Stream - Stream label for
process/outputDeltanotifications. - Rate
Limit Reached Type - Rate
Limit Reset Credit Status - Rate
Limit Reset Type - Remote
Control Clients List Order - Remote
Control Connection Status - Residency
Requirement - Review
Delivery - Review
Target - Sandbox
Mode - Sandbox
Policy - Scheduled
Task Schedule - Scheduled
Task Weekday - Server
Notification - Notification sent from the server to the client.
- Server
Request - Request initiated from the server and sent to the client.
- Server
Request Payload - Server
Response - Typed response from the client to the server.
- Session
Source - Skill
Scope - Sort
Direction - SubAgent
Activity Kind - Thread
Active Flag - Thread
Goal Status - Thread
History Mode - Thread
Item - Thread
List CwdFilter - Thread
Memory Mode - Thread
Realtime Start Transport - EXPERIMENTAL - transport used by thread realtime.
- Thread
Sort Key - Thread
Source - Thread
Source Kind - Thread
Start Source - Thread
Status - Thread
Unsubscribe Status - Turn
Items View - Turn
Plan Step Status - Turn
Status - User
Input - WebSearch
Action - Windows
Sandbox Readiness - Windows
Sandbox Setup Mode - Workspace
Message Type - Write
Status
Traits§
- Experimental
Api - Marker trait for protocol types that can signal experimental usage.
Functions§
- build_
command_ execution_ begin_ item - build_
command_ execution_ end_ item - build_
file_ change_ approval_ request_ item - build_
file_ change_ begin_ item - build_
file_ change_ end_ item - build_
item_ from_ guardian_ event - Build a guardian-derived
ThreadItem. - build_
turns_ from_ rollout_ items - Convert persisted
RolloutItementries into a sequence ofTurnvalues. - convert_
patch_ changes - experimental_
fields - Returns all experimental fields registered across the protocol types.
- experimental_
required_ message - Constructs a consistent error message for experimental gating.
- export_
client_ notification_ schemas - export_
client_ param_ schemas - export_
client_ response_ schemas - export_
client_ responses - export_
server_ notification_ schemas - export_
server_ param_ schemas - export_
server_ response_ schemas - export_
server_ responses - generate_
internal_ json_ schema - generate_
json - generate_
json_ with_ experimental - generate_
ts - generate_
ts_ with_ options - generate_
types - guardian_
auto_ approval_ review_ notification - item_
event_ to_ server_ notification - Build the v2 app-server notification that directly corresponds to a single core event.
- project_
rollout_ line - Project one durable rollout line without reconstructing earlier history.
- read_
schema_ fixture_ subtree - read_
schema_ fixture_ tree - write_
schema_ fixtures - Regenerates
schema/typescript/andschema/json/. - write_
schema_ fixtures_ with_ options - Regenerates schema fixtures with configurable options.