ChatGPT
Set up the connection on chatgpt.com using an account with access to custom apps. In a managed workspace, ask an administrator to make Onsomble available and enable the actions you need. Reading results and changing your Onsomble setup require different tool permissions.1
Turn on developer mode
Open Settings → Security and login and turn on Developer mode. Some
workspace accounts use Settings → Apps → Advanced Settings. If the
option is unavailable, follow OpenAI’s account-specific guide below or ask
your workspace administrator.
2
Add the connector
Open Plugins, use the + button, paste the address above, and name it
Onsomble. If your workspace uses Apps settings, choose Apps → Create
instead. If an administrator has already added Onsomble, select that
existing app.
3
Sign in and approve
Sign in to Onsomble in the browser that opens and approve access. Enable the
connector in a conversation and ask it to list your Sites. Check that the
actions needed for your task are enabled before asking it to change data.
Codex
Add the server with one command:1
Log in
Run
codex mcp login onsomble.2
Approve
Sign in to Onsomble in the browser that opens and approve access.
Use it
Name Onsomble in your first message and name the Site you mean. A few to start with are on the overview. To make the assistant read the results like an analyst, install the Onsomble skills alongside the connection.API keys for scripts and CI
For a product, an internal agent, or a shareable custom GPT, authenticate with an Onsomble API key instead of signing in. Create one in Settings → Account → API Keys: see the API overview. Keys start withons_ and are shown once at creation.
The server publishes tools for reading results and managing your Onsomble setup. Examples include:
Onsomble MCP can read results and, with the required permissions, change Clients, Sites, scan configuration and schedules. Starting a Scan uses prompt executions from your plan’s monthly allowance. Review and approve changes and scan runs before your assistant carries them out. The tools available to a connection depend on its permissions.
Archiving requires your explicit confirmation. Archiving a Client also archives every linked Site and Topic. Archived items leave the active lists and refuse later edits and Scan starts; saved details and reports remain readable by ID. There is no restore through MCP.
The Responses API
Attach the server as a hosted MCP tool. OpenAI’s platform makes the tool calls; you never proxy the traffic.The Agents SDK
MCPServerStreamableHttp) when you want the tool calls to run from your own process instead of OpenAI’s platform.
Custom GPTs
Custom GPTs use GPT Actions, which call the REST API from an OpenAPI schema. Onsomble publishes a schema curated for Actions: Sites, Scan control, and the headline reports, with pagination trimmed for single-call use.- In the GPT editor, open Configure → Actions and select Create new action.
- Import the schema from
https://docs.onsomble.ai/openapi/gpt-actions-v1.json, or paste its contents. - Set Authentication to API Key with auth type Bearer, and paste your API key.