Provider guide

List an integration for a system so buyers can compare access methods, capabilities and operating requirements.

Open listing editor

Choose how to list

First set up your organisation and provider profile in the web app. In the editor, select a system and fill in the sections below. The editor saves as you work and shows the buyer’s view in the live preview. You can suggest a missing system from the editor.

To work from a file, build the CLI and create a key with read and write:listings. This example uses CGM MEDISTAR as the catalog system. Substitute the system your integration supports, keep its ID, and fill in the file with your own facts. The initial capabilities are all none. The local dry run checks the editor fields before saving. The server checks catalog and ownership rules when you push or submit.

Provider agent example
export OPENCOUPLER_API_URL='https://opencoupler.com'
node packages/cli/dist/index.mjs login
node packages/cli/dist/index.mjs listing init cgm-medistar
# Fill the fields with facts about your integration before proceeding.
${EDITOR:-vi} cgm-medistar.listing.json
node packages/cli/dist/index.mjs listing push cgm-medistar.listing.json --dry-run
node packages/cli/dist/index.mjs listing push cgm-medistar.listing.json
node packages/cli/dist/index.mjs listing submit cgm-medistar --confirm
node packages/cli/dist/index.mjs listing status cgm-medistar --json

An agent connected over MCP with the same scopes can call get_system for the data areas and system ID, then upsert_listing with the complete document and a stable slug. Review the facts and confirm accuracy and the marketplace terms before asking it to call submit_listing. Check the result with list_my_listings.

Listing fields

Title, summary and description
Give buyers a recognisable title, a plain-language summary up to 160 characters and any relevant details in the Markdown description.
System and listing status
Choose the software the integration supports and indicate whether your offer is live, in beta or in development.
Capabilities and access
Describe which data areas you can read or write, the access method, and the safeguards for writes.
Interfaces and setup
Link to docs for each interface and describe on-site requirements, authentication and onboarding.
Hosting and data handling
State where the integration runs and what data it passes through, caches or stores. Include evidence for any compliance claims.
Pricing and availability
State the price model, applicable amounts in minor currency units in a file, the countries you serve and what support buyers can expect.

Review and publication

Save a draft, then submit it for review. A person checks it and can approve it or send it back with feedback. Once approved, buyers can find the listing in the catalog, API and MCP.

Material edits change what buyers rely on, including availability status, capabilities, access, hosting, data handling, compliance or pricing. The last approved version stays public while the entire revision waits for review. API-key submissions always go to a person for review. In the browser editor, text-only changes can go live immediately.