Cyclr API — Connectors

naftiko: 1.0.0-alpha2
info:
  label: Cyclr API — Connectors
  description: 'Cyclr API — Connectors. 6 operations. Lead operation: Cyclr List Account Connectors. Self-contained Naftiko
    capability covering one Cyclr business surface.'
  tags:
  - Cyclr
  - Connectors
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CYCLR_API_KEY: CYCLR_API_KEY
capability:
  consumes:
  - type: http
    namespace: cyclr-connectors
    baseUri: https://api.cyclr.com/v1.0
    description: Cyclr API — Connectors business capability. Self-contained, no shared references.
    resources:
    - name: account-connectors
      path: /account/connectors
      operations:
      - name: listaccountconnectors
        method: GET
        description: Cyclr List Account Connectors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: account-connectors-installedConnectorId
      path: /account/connectors/{installedConnectorId}
      operations:
      - name: getaccountconnector
        method: GET
        description: Cyclr Get Account Connector
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: installedConnectorId
          in: path
          type: string
          description: The ID of the installed connector
          required: true
      - name: deleteaccountconnector
        method: DELETE
        description: Cyclr Delete Account Connector
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: installedConnectorId
          in: path
          type: string
          description: The ID of the installed connector
          required: true
    - name: connectors
      path: /connectors
      operations:
      - name: listconnectors
        method: GET
        description: Cyclr List Connectors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Filter connectors by name
        - name: page
          in: query
          type: integer
          description: Page number for pagination
        - name: pageSize
          in: query
          type: integer
          description: Number of results per page
    - name: connectors-connectorId
      path: /connectors/{connectorId}
      operations:
      - name: getconnector
        method: GET
        description: Cyclr Get Connector
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: connectors-connectorId-install
      path: /connectors/{connectorId}/install
      operations:
      - name: installconnector
        method: POST
        description: Cyclr Install Connector
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.CYCLR_API_KEY}}'
  exposes:
  - type: rest
    namespace: cyclr-connectors-rest
    port: 8080
    description: REST adapter for Cyclr API — Connectors. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/account/connectors
      name: account-connectors
      description: REST surface for account-connectors.
      operations:
      - method: GET
        name: listaccountconnectors
        description: Cyclr List Account Connectors
        call: cyclr-connectors.listaccountconnectors
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/account/connectors/{installedconnectorid}
      name: account-connectors-installedconnectorid
      description: REST surface for account-connectors-installedConnectorId.
      operations:
      - method: GET
        name: getaccountconnector
        description: Cyclr Get Account Connector
        call: cyclr-connectors.getaccountconnector
        with:
          installedConnectorId: rest.installedConnectorId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteaccountconnector
        description: Cyclr Delete Account Connector
        call: cyclr-connectors.deleteaccountconnector
        with:
          installedConnectorId: rest.installedConnectorId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/connectors
      name: connectors
      description: REST surface for connectors.
      operations:
      - method: GET
        name: listconnectors
        description: Cyclr List Connectors
        call: cyclr-connectors.listconnectors
        with:
          name: rest.name
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/connectors/{connectorid}
      name: connectors-connectorid
      description: REST surface for connectors-connectorId.
      operations:
      - method: GET
        name: getconnector
        description: Cyclr Get Connector
        call: cyclr-connectors.getconnector
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/connectors/{connectorid}/install
      name: connectors-connectorid-install
      description: REST surface for connectors-connectorId-install.
      operations:
      - method: POST
        name: installconnector
        description: Cyclr Install Connector
        call: cyclr-connectors.installconnector
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cyclr-connectors-mcp
    port: 9090
    transport: http
    description: MCP adapter for Cyclr API — Connectors. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: cyclr-list-account-connectors
      description: Cyclr List Account Connectors
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cyclr-connectors.listaccountconnectors
      outputParameters:
      - type: object
        mapping: $.
    - name: cyclr-get-account-connector
      description: Cyclr Get Account Connector
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cyclr-connectors.getaccountconnector
      with:
        installedConnectorId: tools.installedConnectorId
      outputParameters:
      - type: object
        mapping: $.
    - name: cyclr-delete-account-connector
      description: Cyclr Delete Account Connector
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cyclr-connectors.deleteaccountconnector
      with:
        installedConnectorId: tools.installedConnectorId
      outputParameters:
      - type: object
        mapping: $.
    - name: cyclr-list-connectors
      description: Cyclr List Connectors
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cyclr-connectors.listconnectors
      with:
        name: tools.name
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: cyclr-get-connector
      description: Cyclr Get Connector
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cyclr-connectors.getconnector
      outputParameters:
      - type: object
        mapping: $.
    - name: cyclr-install-connector
      description: Cyclr Install Connector
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cyclr-connectors.installconnector
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.