Miro Developer Platform — Document items

naftiko: 1.0.0-alpha2
info:
  label: Miro Developer Platform — Document items
  description: 'Miro Developer Platform — Document items. 4 operations. Lead operation: Create document item using URL. Self-contained
    Naftiko capability covering one Miro business surface.'
  tags:
  - Miro
  - Document items
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MIRO_API_KEY: MIRO_API_KEY
capability:
  consumes:
  - type: http
    namespace: miro-document-items
    baseUri: https://api.miro.com
    description: Miro Developer Platform — Document items business capability. Self-contained, no shared references.
    resources:
    - name: v2-boards-board_id-documents
      path: /v2/boards/{board_id}/documents
      operations:
      - name: createdocumentitemusingurl
        method: POST
        description: Create document item using URL
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: board_id
          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: true
    - name: v2-boards-board_id-documents-item_id
      path: /v2/boards/{board_id}/documents/{item_id}
      operations:
      - name: getdocumentitem
        method: GET
        description: Get document item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: board_id
          in: path
          type: string
          description: Unique identifier (ID) of the board from which you want to retrieve a specific item.
          required: true
        - name: item_id
          in: path
          type: string
          description: Unique identifier (ID) of the item that you want to retrieve.
          required: true
      - name: updatedocumentitemusingurl
        method: PATCH
        description: Update document item using URL
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: board_id
          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
      - name: deletedocumentitem
        method: DELETE
        description: Delete document item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: board_id
          in: path
          type: string
          description: Unique identifier (ID) of the board from which you want to delete the item.
          required: true
        - name: item_id
          in: path
          type: string
          description: Unique identifier (ID) of the item that you want to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.MIRO_API_KEY}}'
  exposes:
  - type: rest
    namespace: miro-document-items-rest
    port: 8080
    description: REST adapter for Miro Developer Platform — Document items. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/boards/{board-id}/documents
      name: v2-boards-board-id-documents
      description: REST surface for v2-boards-board_id-documents.
      operations:
      - method: POST
        name: createdocumentitemusingurl
        description: Create document item using URL
        call: miro-document-items.createdocumentitemusingurl
        with:
          board_id: rest.board_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/boards/{board-id}/documents/{item-id}
      name: v2-boards-board-id-documents-item-id
      description: REST surface for v2-boards-board_id-documents-item_id.
      operations:
      - method: GET
        name: getdocumentitem
        description: Get document item
        call: miro-document-items.getdocumentitem
        with:
          board_id: rest.board_id
          item_id: rest.item_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatedocumentitemusingurl
        description: Update document item using URL
        call: miro-document-items.updatedocumentitemusingurl
        with:
          board_id: rest.board_id
          item_id: rest.item_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedocumentitem
        description: Delete document item
        call: miro-document-items.deletedocumentitem
        with:
          board_id: rest.board_id
          item_id: rest.item_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: miro-document-items-mcp
    port: 9090
    transport: http
    description: MCP adapter for Miro Developer Platform — Document items. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: create-document-item-using-url
      description: Create document item using URL
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: miro-document-items.createdocumentitemusingurl
      with:
        board_id: tools.board_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-document-item
      description: Get document item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: miro-document-items.getdocumentitem
      with:
        board_id: tools.board_id
        item_id: tools.item_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-document-item-using-url
      description: Update document item using URL
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: miro-document-items.updatedocumentitemusingurl
      with:
        board_id: tools.board_id
        item_id: tools.item_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-document-item
      description: Delete document item
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: miro-document-items.deletedocumentitem
      with:
        board_id: tools.board_id
        item_id: tools.item_id
      outputParameters:
      - type: object
        mapping: $.