Jupyter Server REST API — Contents

naftiko: 1.0.0-alpha2
info:
  label: Jupyter Server REST API — Contents
  description: 'Jupyter Server REST API — Contents. 5 operations. Lead operation: Jupyter Server Get contents. Self-contained
    Naftiko capability covering one Jupyter Server business surface.'
  tags:
  - Jupyter Server
  - Contents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JUPYTER_SERVER_API_KEY: JUPYTER_SERVER_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-contents
    baseUri: http://localhost:8888/api
    description: Jupyter Server REST API — Contents business capability. Self-contained, no shared references.
    resources:
    - name: contents-path
      path: /contents/{path}
      operations:
      - name: getcontents
        method: GET
        description: Jupyter Server Get contents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
        - name: type
          in: query
          type: string
        - name: format
          in: query
          type: string
        - name: content
          in: query
          type: integer
      - name: createcontents
        method: POST
        description: Jupyter Server Create contents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
      - name: renamecontents
        method: PATCH
        description: Jupyter Server Rename contents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
      - name: savecontents
        method: PUT
        description: Jupyter Server Save contents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
      - name: deletecontents
        method: DELETE
        description: Jupyter Server Delete contents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.JUPYTER_SERVER_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-contents-rest
    port: 8080
    description: REST adapter for Jupyter Server REST API — Contents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/contents/{path}
      name: contents-path
      description: REST surface for contents-path.
      operations:
      - method: GET
        name: getcontents
        description: Jupyter Server Get contents
        call: rest-contents.getcontents
        with:
          path: rest.path
          type: rest.type
          format: rest.format
          content: rest.content
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcontents
        description: Jupyter Server Create contents
        call: rest-contents.createcontents
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: renamecontents
        description: Jupyter Server Rename contents
        call: rest-contents.renamecontents
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: savecontents
        description: Jupyter Server Save contents
        call: rest-contents.savecontents
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontents
        description: Jupyter Server Delete contents
        call: rest-contents.deletecontents
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-contents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Jupyter Server REST API — Contents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: jupyter-server-get-contents
      description: Jupyter Server Get contents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-contents.getcontents
      with:
        path: tools.path
        type: tools.type
        format: tools.format
        content: tools.content
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-create-contents
      description: Jupyter Server Create contents
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-contents.createcontents
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-rename-contents
      description: Jupyter Server Rename contents
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-contents.renamecontents
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-save-contents
      description: Jupyter Server Save contents
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-contents.savecontents
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-delete-contents
      description: Jupyter Server Delete contents
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-contents.deletecontents
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.