app.yaml

Lunar.dev’s app.yaml file defines core MCPX settings, including authentication, environment variables, and tool customizations. It is typically located at config/app.yaml, but a custom path can be provided using the APP_CONFIG_PATH environment variable.

Basic

  permissions:
    base: allow
    consumers: {}
  toolGroups: []
  auth:
    enabled: false
  toolExtensions:
    services: {}

Template

  permissions:
    base: allow # required. value can be "allow" or "block" 
    consumers: 
      Consumer1:  # name of consumer group
        base: block # required. value can be "allow" or "block" 
        profiles:
          allow:
            - group1 # example. This needs to correspond to tool group name           
  toolGroups:
    - name: group1 # name of the tool group that corresponds to a group in permissions
      services: 
        serviceName1: # name of the service. This is dynamic and created by the user. 
          - myTool1 # name of tools in the group
          - myTool2
        serviceName2: "*" # the user can use a * to signify all the tools in one service 
    - name: group2
      services:
        serviceName3:
          - myTool3
  auth:
    enabled: # required. boolean "true" or "false"
    header: # optional string. This corresponds to the header from where to get the auth key. 
  toolExtensions:
    services: 
      serviceName1: #name of the service (dynamic, can be what the user chooses)
        toolName: # name of the tool that will be customized
          childTools:
            - name: customToolName
              description: #optional
                action: # "append" or "rewrite" 
                text: "description of custom tool"
              overrideParams: #record tin which each value is a string, a number, or a boolean
                my-param1: 8
                my-param2: "string"
                my-param3: true