Files
openclaw-android-assistant/documentation/APP_SERVER_DOCUMENTATION.md
Pavel Voronin fbc8a668b1 init
2026-02-16 13:57:47 +08:00

90 KiB

APP SERVER DOCUMENTATION

Документ основан на исходниках openai/codex (app-server protocol).

Локальная материализация схем

Все схемы выгружены из upstream codegen (включая experimental) в:

Client -> Server Methods (полный список)

Method Params Schema Response Schema Experimental UI-зона
initialize InitializeParams InitializeResponse stable Контролы и настройки (авторизация/аккаунт)
thread/start ThreadStartParams ThreadStartResponse stable Навигация и загрузка сессий
thread/resume ThreadResumeParams ThreadResumeResponse stable Навигация и загрузка сессий
thread/fork ThreadForkParams ThreadForkResponse stable Навигация и загрузка сессий
thread/archive ThreadArchiveParams ThreadArchiveResponse stable Контролы сессий
thread/name/set ThreadSetNameParams ThreadSetNameResponse stable Контролы сессий
thread/unarchive ThreadUnarchiveParams ThreadUnarchiveResponse stable Контролы сессий
thread/compact/start ThreadCompactStartParams ThreadCompactStartResponse stable Контролы сессий
thread/backgroundTerminals/clean ThreadBackgroundTerminalsCleanParams ThreadBackgroundTerminalsCleanResponse thread/backgroundTerminals/clean Контролы сессий
thread/rollback ThreadRollbackParams ThreadRollbackResponse stable Контролы сессий
thread/list ThreadListParams ThreadListResponse stable Навигация и загрузка сессий
thread/loaded/list ThreadLoadedListParams ThreadLoadedListResponse stable Навигация и загрузка сессий
thread/read ThreadReadParams ThreadReadResponse stable Навигация и загрузка сессий
skills/list SkillsListParams SkillsListResponse stable Контролы и настройки (системная интеграция)
skills/remote/read SkillsRemoteReadParams SkillsRemoteReadResponse stable Контролы и настройки (системная интеграция)
skills/remote/write SkillsRemoteWriteParams SkillsRemoteWriteResponse stable Контролы и настройки (системная интеграция)
app/list AppsListParams AppsListResponse stable Контролы и настройки (системная интеграция)
skills/config/write SkillsConfigWriteParams SkillsConfigWriteResponse stable Контролы и настройки (системная интеграция)
turn/start TurnStartParams TurnStartResponse stable Контентная часть (динамические сообщения)
turn/steer TurnSteerParams TurnSteerResponse stable Контентная часть (динамические сообщения)
turn/interrupt TurnInterruptParams TurnInterruptResponse stable Контентная часть (динамические сообщения)
review/start ReviewStartParams ReviewStartResponse stable Контентная часть (динамические сообщения)
model/list ModelListParams ModelListResponse stable Контролы и настройки (системная интеграция)
experimentalFeature/list ExperimentalFeatureListParams ExperimentalFeatureListResponse stable Контролы и настройки (системная интеграция)
collaborationMode/list CollaborationModeListParams CollaborationModeListResponse stable Контролы и настройки (системная интеграция)
mock/experimentalMethod MockExperimentalMethodParams MockExperimentalMethodResponse stable Контентная часть (статическая/сервисная)
mcpServer/oauth/login McpServerOauthLoginParams McpServerOauthLoginResponse stable Контролы и настройки (авторизация/аккаунт)
config/mcpServer/reload McpServerRefreshResponse stable Контролы и настройки (системная интеграция)
mcpServerStatus/list ListMcpServerStatusParams ListMcpServerStatusResponse stable Контролы и настройки (системная интеграция)
account/login/start LoginAccountParams LoginAccountResponse stable Контролы и настройки (авторизация/аккаунт)
account/login/cancel CancelLoginAccountParams CancelLoginAccountResponse stable Контролы и настройки (авторизация/аккаунт)
account/logout LogoutAccountResponse stable Контролы и настройки (авторизация/аккаунт)
account/rateLimits/read GetAccountRateLimitsResponse stable Контролы и настройки (авторизация/аккаунт)
feedback/upload FeedbackUploadParams FeedbackUploadResponse stable Контролы и настройки (feedback/диагностика)
command/exec CommandExecParams CommandExecResponse stable Контролы выполнения инструментов
config/read ConfigReadParams ConfigReadResponse stable Контролы и настройки (системная интеграция)
config/value/write ConfigValueWriteParams ConfigWriteResponse stable Контролы и настройки (системная интеграция)
config/batchWrite ConfigBatchWriteParams ConfigWriteResponse stable Контролы и настройки (системная интеграция)
configRequirements/read ConfigRequirementsReadResponse stable Контролы и настройки (системная интеграция)
account/read GetAccountParams GetAccountResponse stable Контролы и настройки (авторизация/аккаунт)
newConversation NewConversationParams NewConversationResponse stable Навигация и загрузка сессий
getConversationSummary GetConversationSummaryParams GetConversationSummaryResponse stable Навигация и загрузка сессий
listConversations ListConversationsParams ListConversationsResponse stable Навигация и загрузка сессий
resumeConversation ResumeConversationParams ResumeConversationResponse stable Навигация и загрузка сессий
forkConversation ForkConversationParams ForkConversationResponse stable Навигация и загрузка сессий
archiveConversation ArchiveConversationParams ArchiveConversationResponse stable Контролы сессий
sendUserMessage SendUserMessageParams SendUserMessageResponse stable Контентная часть (динамические сообщения)
sendUserTurn SendUserTurnParams SendUserTurnResponse stable Контентная часть (динамические сообщения)
interruptConversation InterruptConversationParams InterruptConversationResponse stable Контентная часть (динамические сообщения)
addConversationListener AddConversationListenerParams AddConversationSubscriptionResponse stable Контролы сессий
removeConversationListener RemoveConversationListenerParams RemoveConversationSubscriptionResponse stable Контролы сессий
gitDiffToRemote GitDiffToRemoteParams GitDiffToRemoteResponse stable Контролы выполнения инструментов
loginApiKey LoginApiKeyParams LoginApiKeyResponse stable Контролы и настройки (авторизация/аккаунт)
loginChatGpt LoginChatGptResponse stable Контролы и настройки (авторизация/аккаунт)
cancelLoginChatGpt CancelLoginChatGptParams CancelLoginChatGptResponse stable Контентная часть (статическая/сервисная)
logoutChatGpt LogoutChatGptResponse stable Контролы и настройки (авторизация/аккаунт)
getAuthStatus GetAuthStatusParams GetAuthStatusResponse stable Контролы и настройки (авторизация/аккаунт)
getUserSavedConfig GetUserSavedConfigResponse stable Контролы и настройки (системная интеграция)
setDefaultModel SetDefaultModelParams SetDefaultModelResponse stable Контролы и настройки (системная интеграция)
getUserAgent GetUserAgentResponse stable Контролы и настройки (авторизация/аккаунт)
userInfo UserInfoResponse stable Контролы и настройки (авторизация/аккаунт)
fuzzyFileSearch FuzzyFileSearchParams FuzzyFileSearchResponse stable Контролы и настройки (системная интеграция)
fuzzyFileSearch/sessionStart FuzzyFileSearchSessionStartParams FuzzyFileSearchSessionStartResponse fuzzyFileSearch/sessionStart Контролы и настройки (системная интеграция)
fuzzyFileSearch/sessionUpdate FuzzyFileSearchSessionUpdateParams FuzzyFileSearchSessionUpdateResponse fuzzyFileSearch/sessionUpdate Контролы и настройки (системная интеграция)
fuzzyFileSearch/sessionStop FuzzyFileSearchSessionStopParams FuzzyFileSearchSessionStopResponse fuzzyFileSearch/sessionStop Контролы и настройки (системная интеграция)
execOneOffCommand ExecOneOffCommandParams ExecOneOffCommandResponse stable Контролы выполнения инструментов

Server -> Client Requests (полный список)

Method Params Schema Response Schema UI-зона
item/commandExecution/requestApproval CommandExecutionRequestApprovalParams CommandExecutionRequestApprovalResponse Контролы выполнения инструментов
item/fileChange/requestApproval FileChangeRequestApprovalParams FileChangeRequestApprovalResponse Контролы выполнения инструментов
item/tool/requestUserInput ToolRequestUserInputParams ToolRequestUserInputResponse Контролы выполнения инструментов
item/tool/call DynamicToolCallParams DynamicToolCallResponse Контролы выполнения инструментов
account/chatgptAuthTokens/refresh ChatgptAuthTokensRefreshParams ChatgptAuthTokensRefreshResponse Контролы и настройки (авторизация/аккаунт)
applyPatchApproval ApplyPatchApprovalParams ApplyPatchApprovalResponse Контролы выполнения инструментов
execCommandApproval ExecCommandApprovalParams ExecCommandApprovalResponse Контролы выполнения инструментов

Server Notifications (полный список)

Method Payload Schema UI-зона
error ErrorNotification Контентная часть (статическая/сервисная)
thread/started ThreadStartedNotification Контентная часть (статическая/сервисная)
thread/name/updated ThreadNameUpdatedNotification Контентная часть (статическая/сервисная)
thread/tokenUsage/updated ThreadTokenUsageUpdatedNotification Контентная часть (статическая/сервисная)
turn/started TurnStartedNotification Контентная часть (статическая/сервисная)
turn/completed TurnCompletedNotification Контентная часть (статическая/сервисная)
turn/diff/updated TurnDiffUpdatedNotification Контентная часть (статическая/сервисная)
turn/plan/updated TurnPlanUpdatedNotification Контентная часть (статическая/сервисная)
item/started ItemStartedNotification Контролы выполнения инструментов
item/completed ItemCompletedNotification Контролы выполнения инструментов
rawResponseItem/completed RawResponseItemCompletedNotification Контентная часть (статическая/сервисная)
item/agentMessage/delta AgentMessageDeltaNotification Контролы выполнения инструментов
item/plan/delta PlanDeltaNotification Контролы выполнения инструментов
item/commandExecution/outputDelta CommandExecutionOutputDeltaNotification Контролы выполнения инструментов
item/commandExecution/terminalInteraction TerminalInteractionNotification Контролы выполнения инструментов
item/fileChange/outputDelta FileChangeOutputDeltaNotification Контролы выполнения инструментов
item/mcpToolCall/progress McpToolCallProgressNotification Контролы выполнения инструментов
mcpServer/oauthLogin/completed McpServerOauthLoginCompletedNotification Контролы и настройки (системная интеграция)
account/updated AccountUpdatedNotification Контролы и настройки (авторизация/аккаунт)
account/rateLimits/updated AccountRateLimitsUpdatedNotification Контролы и настройки (авторизация/аккаунт)
app/list/updated AppListUpdatedNotification Контентная часть (статическая/сервисная)
item/reasoning/summaryTextDelta ReasoningSummaryTextDeltaNotification Контролы выполнения инструментов
item/reasoning/summaryPartAdded ReasoningSummaryPartAddedNotification Контролы выполнения инструментов
item/reasoning/textDelta ReasoningTextDeltaNotification Контролы выполнения инструментов
thread/compacted ContextCompactedNotification Контентная часть (статическая/сервисная)
deprecationNotice DeprecationNoticeNotification Контентная часть (статическая/сервисная)
configWarning ConfigWarningNotification Контентная часть (статическая/сервисная)
fuzzyFileSearch/sessionUpdated FuzzyFileSearchSessionUpdatedNotification Контролы и настройки (системная интеграция)
fuzzyFileSearch/sessionCompleted FuzzyFileSearchSessionCompletedNotification Контролы и настройки (системная интеграция)
windows/worldWritableWarning WindowsWorldWritableWarningNotification Контентная часть (статическая/сервисная)
account/login/completed AccountLoginCompletedNotification Контролы и настройки (авторизация/аккаунт)
authStatusChange AuthStatusChangeNotification Контентная часть (статическая/сервисная)
loginChatGptComplete LoginChatGptCompleteNotification Контролы и настройки (авторизация/аккаунт)
sessionConfigured SessionConfiguredNotification Контентная часть (статическая/сервисная)

Полный индекс materialized schema-файлов

JSON Root

JSON v1

JSON v2

TypeScript Root

TypeScript v2

Проверка полноты

  • Client methods: 66
  • Server requests: 7
  • Server notifications: 34
  • Materialized JSON root schemas: 37
  • Materialized JSON v1 schemas: 44
  • Materialized JSON v2 schemas: 102
  • Materialized TS root schemas: 236
  • Materialized TS v2 schemas: 199