Couchbase Server REST API — Index Service

naftiko: 1.0.0-alpha2
info:
  label: Couchbase Server REST API — Index Service
  description: 'Couchbase Server REST API — Index Service. 2 operations. Lead operation: Get index service settings. Self-contained
    Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Index Service
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COUCHBASE_API_KEY: COUCHBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: server-rest-index-service
    baseUri: https://localhost:8091
    description: Couchbase Server REST API — Index Service business capability. Self-contained, no shared references.
    resources:
    - name: settings-indexes
      path: /settings/indexes
      operations:
      - name: getindexsettings
        method: GET
        description: Get index service settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateindexsettings
        method: POST
        description: Update index service settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.COUCHBASE_USER}}'
      password: '{{env.COUCHBASE_PASS}}'
  exposes:
  - type: rest
    namespace: server-rest-index-service-rest
    port: 8080
    description: REST adapter for Couchbase Server REST API — Index Service. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/settings/indexes
      name: settings-indexes
      description: REST surface for settings-indexes.
      operations:
      - method: GET
        name: getindexsettings
        description: Get index service settings
        call: server-rest-index-service.getindexsettings
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updateindexsettings
        description: Update index service settings
        call: server-rest-index-service.updateindexsettings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-rest-index-service-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Server REST API — Index Service. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-index-service-settings
      description: Get index service settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-rest-index-service.getindexsettings
      outputParameters:
      - type: object
        mapping: $.
    - name: update-index-service-settings
      description: Update index service settings
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-rest-index-service.updateindexsettings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.