generated: '2026-10-18' method: derived generator: derive-vocabulary.py source: - openapi/mcpgate-api-openapi.json - openapi/mcpgate-demo-openapi.json vocabulary: name: mcpgate Domain Vocabulary description: 'Terms declared by mcpgate''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-18' terms: - term: ActiveCustomerRow definition: 'Object declared by the contract with fields: customer_id, display_name, instance_url, session_id, started_at, expires_at, unread_count.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/ActiveCustomerRow - term: ActiveCustomersResponse definition: 'Object declared by the contract with fields: active.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/ActiveCustomersResponse - term: AuditMetaRequest definition: 'Object declared by the contract with fields: ts, staff_id, action, response_status, response_size, latency_ms.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/AuditMetaRequest - term: BindRequest definition: A gateway claims a subscription with its `instance_token` so it can later pull refreshed tokens. The instance_token is the random hex the gateway received from `/feedback/register`; the backend never has to issue a separate credential for the subscription channel. tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/BindRequest - term: BindResponse definition: 'Object declared by the contract with fields: jti, bound_at.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/BindResponse - term: CommentRequest definition: Reporter-initiated follow-up on their own previously-filed report. Gateway authenticates via ``X-Instance-Token`` like other endpoints; the relay additionally verifies that ``reporter_email`` matches the hash stored when the issue was filed, so only the original reporter can comment. tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/CommentRequest - term: CommentResponse definition: 'Object declared by the contract with fields: ok, issue_iid.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/CommentResponse - term: CustomerCreate definition: 'Object declared by the contract with fields: display_name, contact_email, vat_id, country, stripe_customer_id, notes.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/CustomerCreate - term: CustomerList definition: 'Object declared by the contract with fields: items, total.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/CustomerList - term: CustomerOut definition: 'Object declared by the contract with fields: id, display_name, contact_email, vat_id, country, stripe_customer_id, created_at, notes.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/CustomerOut - term: CustomerUpdate definition: All fields optional — operator updates one at a time. tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/CustomerUpdate - term: EnrollRequest definition: 'Object declared by the contract with fields: instance_url, owner_email, display_name.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/EnrollRequest - term: HTTPValidationError definition: 'Object declared by the contract with fields: detail.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/HTTPValidationError - term: InlineAttachment definition: 'A single binary attachment to a customer-filed bug or feature report. Customers send bytes as base64 on the report-creation request — the bytes only cross the customer→backend boundary once, fitting the transfer-protocol model that bytes are references everywhere *except* the original ingress point. The backend decodes, uploads to the upstream tracker (GitLab `/projects/:id/uploads`), and splices ' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/InlineAttachment - term: IssueRequest definition: Issue a new subscription. Either provide ``owner_id`` to link to an existing customer record, or provide ``customer_name`` (and optionally ``customer_email``) to create one inline. When both are given, ``owner_id`` wins. tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/IssueRequest - term: IssueResponse definition: 'Object declared by the contract with fields: jti, customer_id, owner_id, customer_name, tier, issued_at, expires_at, kid, token.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/IssueResponse - term: MarkMessagesReadRequest definition: 'Gateway → Backend: customer''s browser has opened the dashboard and seen the listed staff messages. Backend stamps customer_read_at so the staff side flips the second tick.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/MarkMessagesReadRequest - term: MessageListResponse definition: 'Object declared by the contract with fields: messages.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/MessageListResponse - term: MessageOut definition: 'Object declared by the contract with fields: id, session_id, direction, author_id, body, ts, customer_read_at, staff_read_at.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/MessageOut - term: MessageRequest definition: 'Object declared by the contract with fields: body, session_id.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/MessageRequest - term: PongListResponse definition: 'Object declared by the contract with fields: pongs.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/PongListResponse - term: PongOut definition: 'Object declared by the contract with fields: id, kind, payload, created_at.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/PongOut - term: PublicKeyResponse definition: 'Object declared by the contract with fields: kid, algorithm, public_key_pem.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/PublicKeyResponse - term: RefreshResponse definition: Returned by `/subscription/refresh` when the calling gateway has a valid binding. The gateway overwrites its stored token with `token`. tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/RefreshResponse - term: RegisterRequest definition: 'Object declared by the contract with fields: instance_url, admin_email, consent_version, pong_delivery.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/RegisterRequest - term: RegisterResponse definition: 'Object declared by the contract with fields: instance_token, pong_delivery.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/RegisterResponse - term: ReleaseRequest definition: 'Object declared by the contract with fields: version, closed_issue_iids.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/ReleaseRequest - term: ReleaseResponse definition: 'Object declared by the contract with fields: ok, pongs_dispatched, pongs_skipped, support_pongs_dispatched, support_pongs_skipped.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/ReleaseResponse - term: ReportRequest definition: 'Object declared by the contract with fields: type, title, description, reporter_email, anonymous, is_test, attachments.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/ReportRequest - term: ReportResponse definition: 'Object declared by the contract with fields: ok, ref, issue_iid.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/ReportResponse - term: RevokeResponse definition: 'Object declared by the contract with fields: jti, revoked_at.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/RevokeResponse - term: SessionCloseRequest definition: 'Object declared by the contract with fields: reason.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SessionCloseRequest - term: SessionCloseResponse definition: 'Object declared by the contract with fields: session_id, closed_at.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SessionCloseResponse - term: SessionExtendRequest definition: 'Object declared by the contract with fields: extend_minutes.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SessionExtendRequest - term: SessionExtendResponse definition: 'Object declared by the contract with fields: session_id, expires_at, max_expires_at, extended.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SessionExtendResponse - term: SessionStartRequest definition: 'Object declared by the contract with fields: ttl_minutes, initial_message.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SessionStartRequest - term: SessionStartResponse definition: 'Object declared by the contract with fields: session_id, started_at, expires_at, max_expires_at, initial_message_id.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SessionStartResponse - term: SubscriptionList definition: 'Object declared by the contract with fields: items, total.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SubscriptionList - term: SubscriptionRow definition: 'Object declared by the contract with fields: jti, customer_id, owner_id, customer_name, customer_email, tier, kid, issued_at, expires_at, issued_by, revoked_at, notes.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/SubscriptionRow - term: UpdateDeliveryRequest definition: Flip an already-registered instance between email and pull-mode. pong_delivery is otherwise fixed at register time; the gateway needs to switch it when the operator toggles "deliver fix updates through my own channels" on/off without re-registering (which would mint a new token and orphan existing reports). tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/UpdateDeliveryRequest - term: UpdateDeliveryResponse definition: 'Object declared by the contract with fields: pong_delivery.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/UpdateDeliveryResponse - term: ValidationError definition: 'Object declared by the contract with fields: loc, msg, type, input, ctx.' tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/ValidationError - term: WebhookNote definition: Subset of GitLab Note Hook payload that we care about. tags: - Object source: openapi/mcpgate-api-openapi.json#/components/schemas/WebhookNote - term: ToolCallRequest definition: Request model for tool calls with strict validation tags: - Object source: openapi/mcpgate-demo-openapi.json#/components/schemas/ToolCallRequest - term: feedback definition: 'Resource group in the contract; its operation POST /feedback/register: Register' tags: - Resource Group source: openapi/mcpgate-api-openapi.json - term: customer definition: 'Resource group in the contract; its operation POST /admin/customer: Create Customer' tags: - Resource Group source: openapi/mcpgate-api-openapi.json - term: subscription definition: 'Resource group in the contract; its operation GET /admin/subscription/public-key: Return the active public key in PEM form for distribution to gateway images.' tags: - Resource Group source: openapi/mcpgate-api-openapi.json - term: subscription-gateway definition: 'Resource group in the contract; its operation POST /subscription/{jti}/bind: A gateway claims this subscription with its instance_token.' tags: - Resource Group source: openapi/mcpgate-api-openapi.json - term: support-gateway definition: 'Resource group in the contract; its operation POST /support/enroll: Enroll a new gateway (first contact) or update an existing one.' tags: - Resource Group source: openapi/mcpgate-api-openapi.json - term: support-admin definition: 'Resource group in the contract; its operation GET /admin/support/active: List Active' tags: - Resource Group source: openapi/mcpgate-api-openapi.json - term: auth-public definition: 'Resource group in the contract; its operation GET /auth/lockout-help: Public recovery procedure for locked-out admins.' tags: - Resource Group source: openapi/mcpgate-demo-openapi.json - term: Context Map definition: 'Resource group in the contract; its operation POST /webhooks/context-map: Git push webhook → re-pull + reindex (idempotent).' tags: - Resource Group source: openapi/mcpgate-demo-openapi.json