Schematic API — plangroups

naftiko: 1.0.0-alpha2
info:
  label: Schematic API — plangroups
  description: 'Schematic API — plangroups. 3 operations. Lead operation: Get plan group. Self-contained Naftiko capability
    covering one Schematic business surface.'
  tags:
  - Schematic
  - plangroups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCHEMATIC_API_KEY: SCHEMATIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: schematic-plangroups
    baseUri: https://api.schematichq.com
    description: Schematic API — plangroups business capability. Self-contained, no shared references.
    resources:
    - name: plan-groups
      path: /plan-groups
      operations:
      - name: getplangroup
        method: GET
        description: Get plan group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_company_counts
          in: query
          type: boolean
      - name: createplangroup
        method: POST
        description: Create plan group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: plan-groups-plan_group_id
      path: /plan-groups/{plan_group_id}
      operations:
      - name: updateplangroup
        method: PUT
        description: Update plan group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: plan_group_id
          in: path
          type: string
          description: plan_group_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-Schematic-Api-Key
      value: '{{env.SCHEMATIC_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: schematic-plangroups-rest
    port: 8080
    description: REST adapter for Schematic API — plangroups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/plan-groups
      name: plan-groups
      description: REST surface for plan-groups.
      operations:
      - method: GET
        name: getplangroup
        description: Get plan group
        call: schematic-plangroups.getplangroup
        with:
          include_company_counts: rest.include_company_counts
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createplangroup
        description: Create plan group
        call: schematic-plangroups.createplangroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plan-groups/{plan-group-id}
      name: plan-groups-plan-group-id
      description: REST surface for plan-groups-plan_group_id.
      operations:
      - method: PUT
        name: updateplangroup
        description: Update plan group
        call: schematic-plangroups.updateplangroup
        with:
          plan_group_id: rest.plan_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: schematic-plangroups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Schematic API — plangroups. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-plan-group
      description: Get plan group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: schematic-plangroups.getplangroup
      with:
        include_company_counts: tools.include_company_counts
      outputParameters:
      - type: object
        mapping: $.
    - name: create-plan-group
      description: Create plan group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: schematic-plangroups.createplangroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-plan-group
      description: Update plan group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: schematic-plangroups.updateplangroup
      with:
        plan_group_id: tools.plan_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.