Skip to content

Guide index

Every resource group on the client, and where it is documented. Every group has a reference entry; the common ones also have a guide. CI fails if a group on the client is missing from this table (see tests/test_docs_coverage.py).

Group What it covers Guide Reference
client.agent List and inspect agents - AgentResource
client.command List slash commands - CommandResource
client.config Read and update configuration - ConfigResource
client.credential Manage provider credentials - CredentialResource
client.debug Inspect loaded locations - DebugResource
client.event Subscribe to server events Guide EventResource
client.experimental Experimental endpoints, such as persistent terminals - ExperimentalResource
client.file Read, list, find and write files - FileResource
client.form List pending forms - FormResource
client.generate One-off text generation - GenerateResource
client.integration Connect and manage integrations - IntegrationResource
client.location Project locations the server knows - LocationResource
client.mcp MCP servers and their resources - McpResource
client.message Read session messages Guide MessageResource
client.migration Data migrations - MigrationResource
client.model List models - ModelResource
client.permission Answer and manage permission requests - PermissionResource
client.plugin List plugins - PluginResource
client.project Projects - ProjectResource
client.provider Model providers - ProviderResource
client.pty Terminals Interactive terminals PtyResource
client.reference References - ReferenceResource
client.rpc Plugin RPC Plugin RPC RpcResource
client.server Server info and health - ServerResource
client.session Sessions, prompts and their sub-resources; run for one-call prompts Guide, headless SessionResource
client.shell Shells - ShellResource
client.skill Skills - SkillResource
client.vcs Version control status and branches - VcsResource
client.voice Voice input - VoiceResource
client.websearch Web search - WebsearchResource
client.worktree Git worktrees - WorktreeResource