naftiko: 1.0.0-alpha2
info:
  label: Lean Entities API — Entities
  description: 'Lean Entities — list and retrieve entity records that represent a customers authenticated bank connection.'
  tags:
  - Lean
  - Entities
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    LEAN_API_TOKEN: LEAN_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: entities-entities
    baseUri: https://api2.leantech.me
    description: Lean Entities API — Entities business capability backed by Lean Technologies APIs.
    resources:
    - name: customer-entities
      path: /customers/v1/{customer_id}/entities
      operations:
      - name: getEntitiesForCustomer
        method: GET
        description: Lean Get Entities For Customer
        outputRawFormat: json
        inputParameters:
        - name: customer_id
          in: path
          type: string
          required: true
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: entity-by-id
      path: /customers/v1/{customer_id}/entities/{entity_id}
      operations:
      - name: getEntityById
        method: GET
        description: Lean Get Entity By Id
        outputRawFormat: json
        inputParameters:
        - name: customer_id
          in: path
          type: string
          required: true
        - name: entity_id
          in: path
          type: string
          required: true
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: all-entities
      path: /customers/v1/entities
      operations:
      - name: retrieveEntitiesForDateRange
        method: GET
        description: Lean Retrieve Entities For Date Range
        outputRawFormat: json
        inputParameters:
        - name: start_date
          in: query
          type: string
          required: false
        - name: end_date
          in: query
          type: string
          required: false
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: 'Bearer {{env.LEAN_API_TOKEN}}'
      placement: header
  exposes:
  - type: rest
    namespace: entities-entities-rest
    port: 8080
    description: REST adapter for Lean Entities API — Entities.
    resources:
    - path: /v1/customers/v1/{customer_id}/entities
      name: customer-entities
      operations:
      - method: GET
        name: getEntitiesForCustomer
        description: Lean Get Entities For Customer
        call: entities-entities.getEntitiesForCustomer
        with:
          customer_id: rest.path.customer_id
    - path: /v1/customers/v1/{customer_id}/entities/{entity_id}
      name: entity-by-id
      operations:
      - method: GET
        name: getEntityById
        description: Lean Get Entity By Id
        call: entities-entities.getEntityById
        with:
          customer_id: rest.path.customer_id
          entity_id: rest.path.entity_id
    - path: /v1/customers/v1/entities
      name: all-entities
      operations:
      - method: GET
        name: retrieveEntitiesForDateRange
        description: Lean Retrieve Entities For Date Range
        call: entities-entities.retrieveEntitiesForDateRange
        with:
          start_date: rest.query.start_date
          end_date: rest.query.end_date
  - type: mcp
    namespace: entities-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Lean Entities API — Entities.
    tools:
    - name: lean-getentitiesforcustomer
      description: Lean Get Entities For Customer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entities-entities.getEntitiesForCustomer
      with:
        customer_id: tools.customer_id
    - name: lean-getentitybyid
      description: Lean Get Entity By Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entities-entities.getEntityById
      with:
        customer_id: tools.customer_id
        entity_id: tools.entity_id
    - name: lean-retrieveentitiesfordaterange
      description: Lean Retrieve Entities For Date Range
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entities-entities.retrieveEntitiesForDateRange
      with:
        start_date: tools.start_date
        end_date: tools.end_date