Miro Developer Platform — documents

naftiko: 1.0.0-alpha2
info:
  label: Miro Developer Platform — documents
  description: 'Miro Developer Platform — documents. 2 operations. Lead operation: Create document item using file from device.
    Self-contained Naftiko capability covering one Miro business surface.'
  tags:
  - Miro
  - documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MIRO_API_KEY: MIRO_API_KEY
capability:
  consumes:
  - type: http
    namespace: miro-documents
    baseUri: https://api.miro.com
    description: Miro Developer Platform — documents business capability. Self-contained, no shared references.
    resources:
    - name: v2-boards-board_id_PlatformFileUpload-documents
      path: /v2/boards/{board_id_PlatformFileUpload}/documents
      operations:
      - name: createdocumentitemusingfilefromdevice
        method: POST
        description: Create document item using file from device
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: board_id_PlatformFileUpload
          in: path
          type: string
          description: Unique identifier (ID) of the board where you want to create the item.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-boards-board_id_PlatformFileUpload-documents-item_id
      path: /v2/boards/{board_id_PlatformFileUpload}/documents/{item_id}
      operations:
      - name: updatedocumentitemusingfilefromdevice
        method: PATCH
        description: Update document item using file from device
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: board_id_PlatformFileUpload
          in: path
          type: string
          description: Unique identifier (ID) of the board where you want to update the item.
          required: true
        - name: item_id
          in: path
          type: string
          description: Unique identifier (ID) of the item that you want to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.MIRO_API_KEY}}'
  exposes:
  - type: rest
    namespace: miro-documents-rest
    port: 8080
    description: REST adapter for Miro Developer Platform — documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/boards/{board-id-platformfileupload}/documents
      name: v2-boards-board-id-platformfileupload-documents
      description: REST surface for v2-boards-board_id_PlatformFileUpload-documents.
      operations:
      - method: POST
        name: createdocumentitemusingfilefromdevice
        description: Create document item using file from device
        call: miro-documents.createdocumentitemusingfilefromdevice
        with:
          board_id_PlatformFileUpload: rest.board_id_PlatformFileUpload
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/boards/{board-id-platformfileupload}/documents/{item-id}
      name: v2-boards-board-id-platformfileupload-documents-item-id
      description: REST surface for v2-boards-board_id_PlatformFileUpload-documents-item_id.
      operations:
      - method: PATCH
        name: updatedocumentitemusingfilefromdevice
        description: Update document item using file from device
        call: miro-documents.updatedocumentitemusingfilefromdevice
        with:
          board_id_PlatformFileUpload: rest.board_id_PlatformFileUpload
          item_id: rest.item_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: miro-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Miro Developer Platform — documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-document-item-using-file
      description: Create document item using file from device
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: miro-documents.createdocumentitemusingfilefromdevice
      with:
        board_id_PlatformFileUpload: tools.board_id_PlatformFileUpload
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-document-item-using-file
      description: Update document item using file from device
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: miro-documents.updatedocumentitemusingfilefromdevice
      with:
        board_id_PlatformFileUpload: tools.board_id_PlatformFileUpload
        item_id: tools.item_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.