Soma API documentation

Rust API reference for every crate in the soma workspace, built by cargo xtask doc.

Workspace crates

• codex-app-server-client — Standalone, fully-typed async Rust client for the Codex CLI's app-server v2 JSON-RPC protocol.
• gotify — Standalone Gotify push-notification server client: messages, applications, clients, and server status.
• incus-client — Async Rust client for the Incus REST API (system container and VM management).
• rmcp-traces — Bounded, log-safe W3C trace metadata helpers for RMCP.
• soma — Product-first RMCP runtime for provider-backed agent capabilities with CLI, REST, HTTP MCP, plugins, and derivative scaffold support.
• soma-api — REST API and HTTP server composition for soma
• soma-application — Transport-neutral product use cases for Soma
• soma-auth — Vendored OAuth 2.0 + JWT auth crate for soma and derived servers.
• soma-cli — CLI surface for soma
• soma-cli-core — Reusable CLI plumbing: output formats, JSON rendering, confirmation I/O, and terminal/color capability policy
• soma-client — Concrete outbound transport for a remote Soma HTTP server
• soma-codemode
• soma-config — Product configuration, environment loading, and env-var registry for soma
• soma-domain — Product domain values and invariant rules for Soma
• soma-gateway — Reusable MCP aggregation gateway runtime
• soma-http-api — Reusable HTTP API surface mechanics: response envelopes, problem details, probe DTOs, route inventory, pagination
• soma-http-server — Reusable Axum server plumbing: listener binding, graceful shutdown, request IDs, tracing, timeouts, body limits, generic CORS, health primitives, rejection envelopes
• soma-integrations — Product adapters wiring soma-application ports to Soma's shared engines (gateway, Code Mode, OpenAPI, upstream OAuth)
• soma-mcp — MCP surface for soma
• soma-mcp-client — Reusable outbound MCP client runtime for upstream discovery, pooling, and calls
• soma-mcp-proxy — Reusable MCP proxy route projection helpers for upstream tools, resources, and prompts
• soma-mcp-server — Reusable inbound MCP server helpers: response paging, protocol conversion, conformance fixtures, trace extraction, and optional Streamable HTTP transport wiring
• soma-observability — Logging, status, and stale-binary helpers for soma
• soma-openapi
• soma-palette — Palette product API for soma: /v1/palette/* routes, DTOs, and product launcher policy
• soma-provider-adapters
• soma-provider-core — Reusable provider contracts, catalogs, validation, and dispatch for Soma-derived runtimes
• soma-runtime — Shared runtime state and auth policy for soma surfaces
• soma-self-update — Standalone, transport-neutral binary self-update transaction for Rust services
• soma-tauri-shell — Reusable Tauri desktop shell mechanics: window, tray, shortcut, blur, and persistence helpers
• soma-test-support — Test helpers for soma crates
• soma-web — Embedded static web UI adapter for soma
• unifi — Core UniFi Network Controller API client: auth, official + internal REST bindings, capability detection, and actions.
• xtask