Gainsight CS Task and Playbook API — Playbooks

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS Task and Playbook API — Playbooks
  description: 'Gainsight CS Task and Playbook API — Playbooks. 2 operations. Lead operation: Gainsight List playbooks. Self-contained
    Naftiko capability covering one Gainsight business surface.'
  tags:
  - Gainsight
  - Playbooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GAINSIGHT_API_KEY: GAINSIGHT_API_KEY
capability:
  consumes:
  - type: http
    namespace: cs-task-and-playbook-playbooks
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS Task and Playbook API — Playbooks business capability. Self-contained, no shared references.
    resources:
    - name: playbooks
      path: /playbooks
      operations:
      - name: listplaybooks
        method: GET
        description: Gainsight List playbooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: playbooks-playbookId
      path: /playbooks/{playbookId}
      operations:
      - name: getplaybook
        method: GET
        description: Gainsight Get a playbook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: accessKey
      value: '{{env.GAINSIGHT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: cs-task-and-playbook-playbooks-rest
    port: 8080
    description: REST adapter for Gainsight CS Task and Playbook API — Playbooks. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/playbooks
      name: playbooks
      description: REST surface for playbooks.
      operations:
      - method: GET
        name: listplaybooks
        description: Gainsight List playbooks
        call: cs-task-and-playbook-playbooks.listplaybooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/playbooks/{playbookid}
      name: playbooks-playbookid
      description: REST surface for playbooks-playbookId.
      operations:
      - method: GET
        name: getplaybook
        description: Gainsight Get a playbook
        call: cs-task-and-playbook-playbooks.getplaybook
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-task-and-playbook-playbooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS Task and Playbook API — Playbooks. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: gainsight-list-playbooks
      description: Gainsight List playbooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-task-and-playbook-playbooks.listplaybooks
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-get-playbook
      description: Gainsight Get a playbook
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-task-and-playbook-playbooks.getplaybook
      outputParameters:
      - type: object
        mapping: $.