Prefect Cloud API — Resources

naftiko: 1.0.0-alpha2
info:
  label: Prefect Cloud API — Resources
  description: 'Prefect Cloud API — Resources. 10 operations. Lead operation: Filter Workspace Resources. Self-contained Naftiko
    capability covering one Prefect business surface.'
  tags:
  - Prefect
  - Resources
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PREFECT_API_KEY: PREFECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: prefect-resources
    baseUri: ''
    description: Prefect Cloud API — Resources business capability. Self-contained, no shared references.
    resources:
    - name: api-accounts-account_id-workspaces-workspace_id-resources-filter
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/filter
      operations:
      - name: filterworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesfilterpost
        method: POST
        description: Filter Workspace Resources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-accounts-account_id-workspaces-workspace_id-resources-filter-count
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/filter/count
      operations:
      - name: getfilteredresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesfiltercountpost
        method: POST
        description: Get Filtered Resources Count
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-accounts-account_id-workspaces-workspace_id-resources-filter-next
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/filter/next
      operations:
      - name: readresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesfilternextget
        method: GET
        description: Read Resources Page
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: page-token
          in: query
          type: string
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-resources-hidden-resources
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/hidden-resources
      operations:
      - name: gethiddenresourcesapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesget
        method: GET
        description: Get Hidden Resources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-resources-hidden-resources-add
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/hidden-resources/add
      operations:
      - name: hideresourcepathapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesaddpost
        method: POST
        description: Hide Resource Path
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-resources-hidden-resources-delet
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/hidden-resources/delete
      operations:
      - name: removeresourceexclusionapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesdeletepost
        method: POST
        description: Remove Resource Exclusion
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-resources-hierarchy-filter
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/hierarchy/filter
      operations:
      - name: readresourceshierarchyapiaccountsaccountidworkspacesworkspaceidresourceshierarchyfilterpost
        method: POST
        description: Read Resources Hierarchy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-resources-related
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/related
      operations:
      - name: filterrelatedworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesrelatedpost
        method: POST
        description: Filter Related Workspace Resources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-accounts-account_id-workspaces-workspace_id-resources-related-count
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/related/count
      operations:
      - name: getrelatedresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesrelatedcountpost
        method: POST
        description: Get Related Resources Count
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-accounts-account_id-workspaces-workspace_id-resources-related-next
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/resources/related/next
      operations:
      - name: readrelatedresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesrelatednextget
        method: GET
        description: Read Related Resources Page
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: page-token
          in: query
          type: string
          required: true
  exposes:
  - type: rest
    namespace: prefect-resources-rest
    port: 8080
    description: REST adapter for Prefect Cloud API — Resources. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/filter
      name: api-accounts-account-id-workspaces-workspace-id-resources-filter
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-filter.
      operations:
      - method: POST
        name: filterworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesfilterpost
        description: Filter Workspace Resources
        call: prefect-resources.filterworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesfilterpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/filter/count
      name: api-accounts-account-id-workspaces-workspace-id-resources-filter-count
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-filter-count.
      operations:
      - method: POST
        name: getfilteredresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesfiltercountpost
        description: Get Filtered Resources Count
        call: prefect-resources.getfilteredresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesfiltercountpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/filter/next
      name: api-accounts-account-id-workspaces-workspace-id-resources-filter-next
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-filter-next.
      operations:
      - method: GET
        name: readresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesfilternextget
        description: Read Resources Page
        call: prefect-resources.readresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesfilternextget
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          page-token: rest.page-token
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/hidden-resources
      name: api-accounts-account-id-workspaces-workspace-id-resources-hidden-resources
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-hidden-resources.
      operations:
      - method: GET
        name: gethiddenresourcesapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesget
        description: Get Hidden Resources
        call: prefect-resources.gethiddenresourcesapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesget
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/hidden-resources/add
      name: api-accounts-account-id-workspaces-workspace-id-resources-hidden-resources-add
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-hidden-resources-add.
      operations:
      - method: POST
        name: hideresourcepathapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesaddpost
        description: Hide Resource Path
        call: prefect-resources.hideresourcepathapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesaddpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/hidden-resources/delete
      name: api-accounts-account-id-workspaces-workspace-id-resources-hidden-resources-delet
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-hidden-resources-delet.
      operations:
      - method: POST
        name: removeresourceexclusionapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesdeletepost
        description: Remove Resource Exclusion
        call: prefect-resources.removeresourceexclusionapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesdeletepost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/hierarchy/filter
      name: api-accounts-account-id-workspaces-workspace-id-resources-hierarchy-filter
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-hierarchy-filter.
      operations:
      - method: POST
        name: readresourceshierarchyapiaccountsaccountidworkspacesworkspaceidresourceshierarchyfilterpost
        description: Read Resources Hierarchy
        call: prefect-resources.readresourceshierarchyapiaccountsaccountidworkspacesworkspaceidresourceshierarchyfilterpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/related
      name: api-accounts-account-id-workspaces-workspace-id-resources-related
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-related.
      operations:
      - method: POST
        name: filterrelatedworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesrelatedpost
        description: Filter Related Workspace Resources
        call: prefect-resources.filterrelatedworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesrelatedpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/related/count
      name: api-accounts-account-id-workspaces-workspace-id-resources-related-count
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-related-count.
      operations:
      - method: POST
        name: getrelatedresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesrelatedcountpost
        description: Get Related Resources Count
        call: prefect-resources.getrelatedresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesrelatedcountpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/resources/related/next
      name: api-accounts-account-id-workspaces-workspace-id-resources-related-next
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-resources-related-next.
      operations:
      - method: GET
        name: readrelatedresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesrelatednextget
        description: Read Related Resources Page
        call: prefect-resources.readrelatedresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesrelatednextget
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          page-token: rest.page-token
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: prefect-resources-mcp
    port: 9090
    transport: http
    description: MCP adapter for Prefect Cloud API — Resources. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: filter-workspace-resources
      description: Filter Workspace Resources
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-resources.filterworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesfilterpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-filtered-resources-count
      description: Get Filtered Resources Count
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: prefect-resources.getfilteredresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesfiltercountpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-resources-page
      description: Read Resources Page
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-resources.readresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesfilternextget
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        page-token: tools.page-token
      outputParameters:
      - type: object
        mapping: $.
    - name: get-hidden-resources
      description: Get Hidden Resources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-resources.gethiddenresourcesapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesget
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
      outputParameters:
      - type: object
        mapping: $.
    - name: hide-resource-path
      description: Hide Resource Path
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-resources.hideresourcepathapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesaddpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-resource-exclusion
      description: Remove Resource Exclusion
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-resources.removeresourceexclusionapiaccountsaccountidworkspacesworkspaceidresourceshiddenresourcesdeletepost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-resources-hierarchy
      description: Read Resources Hierarchy
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-resources.readresourceshierarchyapiaccountsaccountidworkspacesworkspaceidresourceshierarchyfilterpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: filter-related-workspace-resources
      description: Filter Related Workspace Resources
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-resources.filterrelatedworkspaceresourcesapiaccountsaccountidworkspacesworkspaceidresourcesrelatedpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-related-resources-count
      description: Get Related Resources Count
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: prefect-resources.getrelatedresourcescountapiaccountsaccountidworkspacesworkspaceidresourcesrelatedcountpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-related-resources-page
      description: Read Related Resources Page
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-resources.readrelatedresourcespageapiaccountsaccountidworkspacesworkspaceidresourcesrelatednextget
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        page-token: tools.page-token
      outputParameters:
      - type: object
        mapping: $.