naftiko: 1.0.0-alpha2
info:
  label: Sendcloud API — Orders
  description: 'Sendcloud API v3 — Orders. List, retrieve, update, and delete orders pulled in from integrations.'
  tags:
  - Sendcloud
  - Orders
  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-orders
    baseUri: https://panel.sendcloud.sc/api/v3
    description: Sendcloud Orders API v3.
    resources:
    - name: orders
      path: /orders
      operations:
      - name: listorders
        method: GET
        description: Retrieve a list of orders.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cursor
          in: query
          type: string
        - name: limit
          in: query
          type: integer
    - name: orders-id
      path: /orders/{id}
      operations:
      - name: retrieveorder
        method: GET
        description: Retrieve an order.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: updateorder
        method: PATCH
        description: Update an order.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          required: true
      - name: deleteorder
        method: DELETE
        description: Delete an order.
        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-orders-mcp
    port: 9091
    transport: http
    description: MCP adapter for Sendcloud Orders.
    tools:
    - name: list-orders
      description: Retrieve a list of orders.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendcloud-orders.listorders
      with:
        cursor: tools.cursor
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-order
      description: Retrieve an order.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendcloud-orders.retrieveorder
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-order
      description: Update an order.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sendcloud-orders.updateorder
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-order
      description: Delete an order.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sendcloud-orders.deleteorder
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.