naftiko: 1.0.0-alpha2
info:
  label: Sendcloud API — Returns
  description: 'Sendcloud API v3 — Returns. Create, validate, list, announce, and cancel return shipments.'
  tags:
  - Sendcloud
  - Returns
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    SENDCLOUD_PUBLIC_KEY: SENDCLOUD_PUBLIC_KEY
    SENDCLOUD_PRIVATE_KEY: SENDCLOUD_PRIVATE_KEY
capability:
  consumes:
  - type: http
    namespace: sendcloud-returns
    baseUri: https://panel.sendcloud.sc/api/v3
    description: Sendcloud Returns API v3.
    resources:
    - name: returns
      path: /returns
      operations:
      - name: listreturns
        method: GET
        description: Retrieve a list of returns.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cursor
          in: query
          type: string
        - name: limit
          in: query
          type: integer
      - name: createreturn
        method: POST
        description: Create a return.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: returns-validate
      path: /returns/validate
      operations:
      - name: validatereturn
        method: POST
        description: Validate a return request before creating it.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: returns-announce
      path: /returns/announce-synchronously
      operations:
      - name: announcereturn
        method: POST
        description: Create and announce a return synchronously.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: returns-id
      path: /returns/{id}
      operations:
      - name: retrievereturn
        method: GET
        description: Retrieve a return.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: returns-id-cancel
      path: /returns/{id}/cancel
      operations:
      - name: cancelreturn
        method: POST
        description: Cancel a return.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: basic
      username: '{{env.SENDCLOUD_PUBLIC_KEY}}'
      password: '{{env.SENDCLOUD_PRIVATE_KEY}}'
  exposes:
  - type: mcp
    namespace: sendcloud-returns-mcp
    port: 9092
    transport: http
    description: MCP adapter for Sendcloud Returns.
    tools:
    - name: list-returns
      description: Retrieve a list of returns.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendcloud-returns.listreturns
      with:
        cursor: tools.cursor
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-return
      description: Create a return.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sendcloud-returns.createreturn
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-return
      description: Validate a return request before creating it.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendcloud-returns.validatereturn
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: announce-return
      description: Create and announce a return synchronously.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sendcloud-returns.announcereturn
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-return
      description: Retrieve a return.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendcloud-returns.retrievereturn
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-return
      description: Cancel a return.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sendcloud-returns.cancelreturn
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.