Manifest
The manifest is the connector’s single source of truth. The console, the tool catalogue, the verification rule and the certificate all read from it.
Contract: contracts/integration/v1/connector-manifest.schema.json
Top level
Section titled “Top level”{ "id": "bitrix24", "version": "2.1.0", "category": "crm", "display_name": "Bitrix24", "scope": "global", "description": "…", "auth": { }, "config_schema": { }, "operations": [ ]}| Field | Rule |
|---|---|
id |
^[a-z][a-z0-9_.-]{1,63}$ — used in URL paths |
version |
semver. Adding an operation is MINOR |
category |
crm erp bank storage speech payments messaging inventory productivity api database |
scope |
global or tenant:<id> |
Authentication
Section titled “Authentication”"auth": { "type": "api_key", "credential_ref": "vault:connectors/bitrix24"}config_schema
Section titled “config_schema”Settings a tenant instance fills in (portal URL, pipeline id, …). JSON
Schema with additionalProperties: false.
⚠ These are not secrets. Secrets only ever arrive via credential_ref.
Operations
Section titled “Operations”{ "name": "crm.get_deal", "direction": "read", "risk_level": "L1", "idempotent": true, "timeout_ms": 15000, "description": "…", "input_schema": { "type": "object", "additionalProperties": false, "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9]{1,19}$" } } }, "output_schema": { }, "verification": { }}direction
Section titled “direction”| Value | Meaning |
|---|---|
read |
Read — no ledger entry |
write |
Write — ledger, idempotency, verification |
stream |
Streaming |
risk_level
Section titled “risk_level”L0 … L4 — informational only. Approval and policy decisions are
not in the manifest; they belong to the platform.
idempotent
Section titled “idempotent”Whether the provider itself deduplicates. If false, protection comes
only from the platform’s semantic key.
⚠ Be honest. Claiming true falsely is a source of duplicate effects.
Mistakes that bite
Section titled “Mistakes that bite”| ⛔ Mistake | Consequence |
|---|---|
| Returning identifiers as numbers | ids above 2⁵³ corrupt |
upstream_error for an unknown id |
Index lag becomes FAILED |
output_schema differs from reality |
The predicate field cannot be found |
| Setting the predicate field conditionally | field_missing → silent UNKNOWN |
| URL or token in an error message | The secret reaches the model’s context |
Versioning
Section titled “Versioning”| Change | Version |
|---|---|
| Adding an operation | MINOR |
| Adding an optional field | MINOR |
| Removing / renaming an operation | MAJOR |
Narrowing output_schema |
MAJOR |
⚠ A Domain Pack requires a minimum connector version (min_version).
If the read-back appeared in a newer version, the pack will not install
below it.
- The verification block — ⚡ most important
- Conformance suite