frp Client Admin API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: frp Client Admin API — Configuration
  description: 'frp Client Admin API — Configuration. 4 operations. Lead operation: Get current configuration. Self-contained
    Naftiko capability covering one Frp business surface.'
  tags:
  - Frp
  - Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRP_API_KEY: FRP_API_KEY
capability:
  consumes:
  - type: http
    namespace: client-admin-configuration
    baseUri: http://{host}:{port}
    description: frp Client Admin API — Configuration business capability. Self-contained, no shared references.
    resources:
    - name: api-config
      path: /api/config
      operations:
      - name: getconfig
        method: GET
        description: Get current configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putconfig
        method: PUT
        description: Replace configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-proxy-name-config
      path: /api/proxy/{name}/config
      operations:
      - name: getproxyconfig
        method: GET
        description: Get proxy configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Proxy name
          required: true
    - name: api-visitor-name-config
      path: /api/visitor/{name}/config
      operations:
      - name: getvisitorconfig
        method: GET
        description: Get visitor configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Visitor name
          required: true
    authentication:
      type: basic
      username: '{{env.FRP_USER}}'
      password: '{{env.FRP_PASS}}'
  exposes:
  - type: rest
    namespace: client-admin-configuration-rest
    port: 8080
    description: REST adapter for frp Client Admin API — Configuration. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/config
      name: api-config
      description: REST surface for api-config.
      operations:
      - method: GET
        name: getconfig
        description: Get current configuration
        call: client-admin-configuration.getconfig
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putconfig
        description: Replace configuration
        call: client-admin-configuration.putconfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/proxy/{name}/config
      name: api-proxy-name-config
      description: REST surface for api-proxy-name-config.
      operations:
      - method: GET
        name: getproxyconfig
        description: Get proxy configuration
        call: client-admin-configuration.getproxyconfig
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/visitor/{name}/config
      name: api-visitor-name-config
      description: REST surface for api-visitor-name-config.
      operations:
      - method: GET
        name: getvisitorconfig
        description: Get visitor configuration
        call: client-admin-configuration.getvisitorconfig
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: client-admin-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for frp Client Admin API — Configuration. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-current-configuration
      description: Get current configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: client-admin-configuration.getconfig
      outputParameters:
      - type: object
        mapping: $.
    - name: replace-configuration
      description: Replace configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: client-admin-configuration.putconfig
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-proxy-configuration
      description: Get proxy configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: client-admin-configuration.getproxyconfig
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-visitor-configuration
      description: Get visitor configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: client-admin-configuration.getvisitorconfig
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.