Integrate an application

An application adapter is a small manifest that declares how a desktop app connects to Bricoop, which models it accepts, and how Bricoop detects and configures it. A single manifest reaches every supported provider, so you publish once and every connected provider becomes available to that application. The adapter never embeds provider credentials or provider-specific logic; it only describes the application side of the connection.

What an adapter does

The adapter tells Bricoop where the application stores its configuration, which model slots the user can map, and which capabilities the application expects to use. Bricoop reads the manifest, patches the application’s local config file when the user enables a provider, and routes requests through the local connection layer. The application keeps working as it always has; Bricoop only writes the provider endpoint into the slot the manifest declares.

Before you start

Confirm you have a stable lowercase id for the application, the minimal_client_version of Bricoop Desktop it requires, the model slots it exposes, and the config paths it writes to. You also need the application’s schema_version and minimal_application_version so Bricoop can reject incompatible combinations explicitly. When the manifest is ready, move on to the Application manifest reference.

Write the manifest

Author the manifest as a single YAML file that declares id, name, version, schema_version, minimal_client_version, minimal_application_version, model_slots, and configs. The configs entries tell Bricoop how to locate and patch the application’s config on macOS, Linux, and Windows. See the Application manifest page for the full field reference and a complete example.

Test locally

Run Bricoop Desktop, point it at your local manifest, and confirm the application is detected. Enable one provider, make a single request round-trip through the application, and verify the response comes back without errors. If detection fails, re-check the configs[].path values for each platform.

Open a pull request

When the manifest works locally, open a reviewable pull request against bricoop-releases following the registry contribution guide. The repository’s validation runs before the PR can merge, so fix every reported issue before requesting review. Once the PR merges, a release manifest is published and Bricoop Desktop picks it up. To build a provider adapter instead, see the provider overview.