The server methods expose configuration, runtime diagnostics, provider management, voice transcription, and keybinding management. Related provider discovery and workspace methods are also documented here. All methods follow the WebSocket protocol.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Emanuele-web04/dpcode/llms.txt
Use this file to discover all available pages before exploring further.
server.getConfig
Retrieve the current server configuration, including provider statuses, keybindings, and config validation issues.Parameters
No parameters required.Response (ServerConfig)
Server working directory.
Server home directory, if configured.
Directory where managed worktrees are stored.
Path to the keybindings config file.
Resolved keybindings configuration.
Array of config validation issues.
Array of
ServerProviderStatus objects (see server.refreshProviders).List of detected editor identifiers (e.g.
"vscode", "cursor").server.getEnvironment
Retrieve the server’s execution environment descriptor.Parameters
No parameters required.Response
Returns anExecutionEnvironmentDescriptor object describing the current runtime environment (OS, architecture, and environment-specific metadata).
server.getSettings
Retrieve current server settings.Parameters
No parameters required.Response
Returns aServerSettings object containing all user-configurable settings.
server.updateSettings
Update one or more server settings. Accepts a partial patch — only the fields you include are changed.Parameters
A
ServerSettingsPatch — a partial object containing any subset of the ServerSettings fields you want to update.Response
Returns the updatedServerSettings object.
server.refreshProviders
Probe all registered providers and refresh their health and auth status.Parameters
No parameters required.Response
Updated array of
ServerProviderStatus objects (same as in server.getConfig).server.updateProvider
Trigger an update for a specific provider CLI binary.Parameters
Provider kind to update. One of:
"codex", "claudeAgent", "cursor", "gemini", "grok", "kilo", "opencode", "pi".Response
Returns updatedproviders array (same as server.refreshProviders).
Errors
Returns aServerProviderUpdateError with provider and reason fields if the update fails.
server.getProviderUsageSnapshot
Retrieve usage statistics for a specific provider.Parameters
Provider kind to query.
Optional provider home path override.
Response
ReturnsServerProviderUsageSnapshot | null.
Human-readable usage lines. Each has
label, value, and optional subtitle.Where the usage data was fetched from.
server.getDiagnostics
Retrieve server diagnostics including process memory usage and child process inventory.Parameters
No parameters required.Response
Up to 80 child processes. Each has
pid, ppid, rssBytes, virtualSizeBytes, command, and args (sensitive values redacted).{ projectCount, threadCount } — counts from the orchestration projection.server.transcribeVoice
Transcribe an audio recording to text using a provider’s voice transcription API.Parameters
Provider to use for transcription (must have
voiceTranscriptionAvailable: true).Working directory context.
Optional thread context for the transcription.
MIME type of the audio data (e.g.
"audio/webm"). Max 100 characters.Sample rate of the audio in Hz.
Duration of the audio in milliseconds.
Base64-encoded audio data. Max ~14 MB encoded.
Response
Transcribed text.
server.upsertKeybinding
Add or update a keybinding rule. Returns the full updated keybindings configuration.Parameters
Command identifier the keybinding should trigger.
Key combination (e.g.
"ctrl+shift+p").Optional context expression that must be true for the keybinding to activate.
Response
Resolved keybindings configuration after the upsert.
Any validation issues found in the keybindings file after writing.
server.subscribeLifecycle
Streaming. Subscribe to server lifecycle events. The server emits awelcome event immediately, followed by ready when initialization is complete, and maintenance events during background maintenance tasks.
Parameters
No parameters required.Stream items (ServerLifecycleStreamEvent)
One of:
"welcome", "ready", "maintenance".server.subscribeConfig
Streaming. Subscribe to server configuration changes. The server emits asnapshot first with the full config, then streams incremental update events.
Parameters
No parameters required.Stream items (ServerConfigStreamEvent)
type | Description |
|---|---|
snapshot | Full ServerConfig in config field — emitted once on subscribe. |
configUpdated | payload: { issues, providers } — config issues or provider statuses changed. |
providerStatuses | payload: { providers } — provider health refreshed. |
settingsUpdated | payload: { settings } — settings changed. |
server.subscribeProviderStatuses
Streaming. Subscribe to provider status updates. Each stream item contains the full updatedproviders array.
Parameters
No parameters required.Stream items
Updated
ServerProviderStatus array.server.subscribeSettings
Streaming. Subscribe to settings changes. Emits a current snapshot first, then emits whenever settings are updated.Parameters
No parameters required.Stream items
Current
ServerSettings object.provider.getComposerCapabilities
Retrieve what capabilities a provider’s composer supports (e.g. streaming, file attachments, skills).Parameters
Provider kind.
Response
Returns aProviderComposerCapabilities object describing the provider’s feature set.
provider.compactThread
Compact a thread’s conversation history to reduce token usage on the next turn.Parameters
Thread to compact.
Response
Returns void on success.provider.listCommands
List available slash commands for a provider.Parameters
Response
Returns aProviderListCommandsResult with an array of command definitions.
provider.listSkills
List available skills (tools/capabilities) for a provider.Parameters
Response
Returns aProviderListSkillsResult with an array of skill definitions.
provider.listPlugins
List available plugins for a provider.Parameters
Response
Returns aProviderListPluginsResult with an array of plugin identifiers and metadata.
provider.readPlugin
Read the content or configuration of a specific plugin.Parameters
Response
Returns aProviderReadPluginResult with the plugin definition.
provider.listModels
List available models for a provider.Parameters
Response
Returns aProviderListModelsResult with an array of model identifiers and metadata.
provider.listAgents
List available agents for a provider.Parameters
Response
Returns aProviderListAgentsResult with an array of agent definitions.
Workspace methods
These methods provide file and directory access within project workspaces.projects.listDirectories
List directories within a project’s workspace.Subdirectory path relative to the workspace root.
ProjectListDirectoriesResult with an array of directory entries.
projects.searchEntries
Search for files and directories within a project using a query string.ProjectSearchEntriesResult with matching entries.
projects.searchLocalEntries
Search for files and directories using the local filesystem index.ProjectSearchLocalEntriesResult with matching entries.
projects.writeFile
Write content to a file within a project workspace.File path relative to the workspace root.
ProjectWriteFileResult confirming the write.
filesystem.browse
Browse the server filesystem at a given path.Absolute path to browse.
FilesystemBrowseResult with directory entries and metadata.
shell.openInEditor
Open a file or directory in the user’s configured editor.Absolute path to open.
Specific editor to use. If omitted, the default configured editor is used.