Skip to main content
Use this page as the starting context for an agent integrating Offline Protocol. Choose one workflow and read its prerequisites before writing code.

​
Choose a reading path

​
Give the agent a concrete brief

Start with the live agent setup prompt. Give its URL to your agent, or open it and copy its current contents. It is the canonical setup instruction; this page does not keep a second copy. Add your repository, target device models and OS, installed SDK version, intended workflow, available transports, enrollment policy and storage/backend requirements. Tell the agent what success looks like and which device tests it must run. Connect local MCP for package discovery and scaffolding without credentials, or hosted MCP with an application API key and matching app ID. Hosted mode supplies context and planning but cannot write project files. Neither mode runs the mesh or contacts peers. A phone-to-phone integration needs native device execution. A web app using the OfflineID SDK does not gain local mesh transport. The local Mesh quickstart needs no portal API key.

​
Fetch only the context you need

Use Copy page to copy the current page as Markdown, or View as Markdown in the adjacent menu. On the hosted docs, append .md to a page path for its Markdown representation. The docs site’s llms.txt lists the available pages; start there when the task does not name a page. Read the selected workflow, then its focused API reference. Use llms-full.txt only when you need a full-site export; it includes unrelated products and consumes more context. Keep the documentation site’s base path when constructing these URLs. The page menu can hand documentation context to an assistant. It does not execute the SDK or connect to your devices. Offline Protocol CLI and MCP provide integration guidance and scaffolding separately from the docs menu.

​
Check the implementation

  • Register listeners before startup and narrow event.type before reading event-specific fields.
  • Use the discovered device address for messaging; a username, project ID or API key is not a peer address.
  • Match each peer’s platform and transport. A shared transport label alone does not establish interoperability.
  • Keep service RPC bodies non-sensitive: they are signed plaintext in v0.27.0.
  • Track transport delivery, application acceptance and destination commit separately.
  • Preserve operation IDs across retries. A timeout does not prove a remote operation did no work.
  • Compile the changed application and test on the target devices. A typecheck or mock cannot establish radio delivery.
Continue with production qualification once the local workflow works.

​
Release boundaries

Phone Wi-Fi Direct and MultipeerConnectivity carry no traffic in v0.27.0. Use BLE or provisioned relay credentials. Read public types, errors and defaults when choosing limits and recovery behavior. Hosted HTTP integrations use a user JWT plus X-App-Id, not a portal secret; follow the API introduction.