Restaurants API

naftiko: 1.0.0-alpha2
info:
  label: Restaurants API
  description: 'Restaurants API. 2 operations. Lead operation: Toast Get Restaurants in a Management Group. Self-contained
    Naftiko capability covering one Toast business surface.'
  tags:
  - Toast
  - Restaurants API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TOAST_API_KEY: TOAST_API_KEY
capability:
  consumes:
  - type: http
    namespace: restaurants
    baseUri: https://toast-api-server/restaurants/v1
    description: Restaurants API business capability. Self-contained, no shared references.
    resources:
    - name: groups-managementGroupGUID-restaurants
      path: /groups/{managementGroupGUID}/restaurants
      operations:
      - name: groupsmanagementgroupguidrestaurantsget
        method: GET
        description: Toast Get Restaurants in a Management Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: managementGroupGUID
          in: path
          type: string
          description: The GUID of the restaurant management group.
          required: true
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: 'The Toast GUID of one restaurant location in the management '
          required: true
    - name: restaurants-restaurantGUID
      path: /restaurants/{restaurantGUID}
      operations:
      - name: restaurantsrestaurantguidget
        method: GET
        description: Toast Get Restaurant Configuration Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restaurantGUID
          in: path
          type: string
          description: 'The Toast GUID of the restaurant that you want to get '
          required: true
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: 'The Toast GUID of the restaurant that you want to get '
          required: true
        - name: includeArchived
          in: query
          type: boolean
          description: Set `includeArchived` to `true` if the API should return information
  exposes:
  - type: rest
    namespace: restaurants-rest
    port: 8080
    description: REST adapter for Restaurants API. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/groups/{managementgroupguid}/restaurants
      name: groups-managementgroupguid-restaurants
      description: REST surface for groups-managementGroupGUID-restaurants.
      operations:
      - method: GET
        name: groupsmanagementgroupguidrestaurantsget
        description: Toast Get Restaurants in a Management Group
        call: restaurants.groupsmanagementgroupguidrestaurantsget
        with:
          managementGroupGUID: rest.managementGroupGUID
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/restaurants/{restaurantguid}
      name: restaurants-restaurantguid
      description: REST surface for restaurants-restaurantGUID.
      operations:
      - method: GET
        name: restaurantsrestaurantguidget
        description: Toast Get Restaurant Configuration Information
        call: restaurants.restaurantsrestaurantguidget
        with:
          restaurantGUID: rest.restaurantGUID
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          includeArchived: rest.includeArchived
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: restaurants-mcp
    port: 9090
    transport: http
    description: MCP adapter for Restaurants API. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: toast-get-restaurants-management-group
      description: Toast Get Restaurants in a Management Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: restaurants.groupsmanagementgroupguidrestaurantsget
      with:
        managementGroupGUID: tools.managementGroupGUID
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-get-restaurant-configuration-information
      description: Toast Get Restaurant Configuration Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: restaurants.restaurantsrestaurantguidget
      with:
        restaurantGUID: tools.restaurantGUID
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        includeArchived: tools.includeArchived
      outputParameters:
      - type: object
        mapping: $.