Couchbase · Capability

Couchbase Server REST API — Logs

Couchbase Server REST API — Logs. 2 operations. Lead operation: Start log collection. Self-contained Naftiko capability covering one Couchbase business surface.

Run with Naftiko CouchbaseLogs

What You Can Do

POST
Startlogcollection — Start log collection
/v1/controller/startlogscollection
GET
Getdiagnostics — Get diagnostic information
/v1/diag

MCP Tools

start-log-collection

Start log collection

get-diagnostic-information

Get diagnostic information

read-only idempotent

Capability Spec

server-rest-logs.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Couchbase Server REST API — Logs
  description: 'Couchbase Server REST API — Logs. 2 operations. Lead operation: Start log collection. Self-contained Naftiko
    capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Logs
  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-logs
    baseUri: https://localhost:8091
    description: Couchbase Server REST API — Logs business capability. Self-contained, no shared references.
    resources:
    - name: controller-startLogsCollection
      path: /controller/startLogsCollection
      operations:
      - name: startlogcollection
        method: POST
        description: Start log collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: diag
      path: /diag
      operations:
      - name: getdiagnostics
        method: GET
        description: Get diagnostic information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.COUCHBASE_USER}}'
      password: '{{env.COUCHBASE_PASS}}'
  exposes:
  - type: rest
    namespace: server-rest-logs-rest
    port: 8080
    description: REST adapter for Couchbase Server REST API — Logs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/controller/startlogscollection
      name: controller-startlogscollection
      description: REST surface for controller-startLogsCollection.
      operations:
      - method: POST
        name: startlogcollection
        description: Start log collection
        call: server-rest-logs.startlogcollection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/diag
      name: diag
      description: REST surface for diag.
      operations:
      - method: GET
        name: getdiagnostics
        description: Get diagnostic information
        call: server-rest-logs.getdiagnostics
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-rest-logs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Server REST API — Logs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: start-log-collection
      description: Start log collection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-rest-logs.startlogcollection
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-diagnostic-information
      description: Get diagnostic information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-rest-logs.getdiagnostics
      outputParameters:
      - type: object
        mapping: $.