Gainsight CS Success Plan API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS Success Plan API — Configuration
  description: 'Gainsight CS Success Plan API — Configuration. 1 operations. Lead operation: Gainsight Get success plan types.
    Self-contained Naftiko capability covering one Gainsight business surface.'
  tags:
  - Gainsight
  - Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GAINSIGHT_API_KEY: GAINSIGHT_API_KEY
capability:
  consumes:
  - type: http
    namespace: cs-success-plan-configuration
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS Success Plan API — Configuration business capability. Self-contained, no shared references.
    resources:
    - name: successplans-config-types
      path: /successplans/config/types
      operations:
      - name: getsuccessplantypes
        method: GET
        description: Gainsight Get success plan types
        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-success-plan-configuration-rest
    port: 8080
    description: REST adapter for Gainsight CS Success Plan API — Configuration. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/successplans/config/types
      name: successplans-config-types
      description: REST surface for successplans-config-types.
      operations:
      - method: GET
        name: getsuccessplantypes
        description: Gainsight Get success plan types
        call: cs-success-plan-configuration.getsuccessplantypes
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-success-plan-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS Success Plan API — Configuration. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: gainsight-get-success-plan-types
      description: Gainsight Get success plan types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-success-plan-configuration.getsuccessplantypes
      outputParameters:
      - type: object
        mapping: $.