frp Client Admin API — Store

naftiko: 1.0.0-alpha2
info:
  label: frp Client Admin API — Store
  description: 'frp Client Admin API — Store. 10 operations. Lead operation: List stored proxies. Self-contained Naftiko capability
    covering one Frp business surface.'
  tags:
  - Frp
  - Store
  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-store
    baseUri: http://{host}:{port}
    description: frp Client Admin API — Store business capability. Self-contained, no shared references.
    resources:
    - name: api-store-proxies
      path: /api/store/proxies
      operations:
      - name: liststoreproxies
        method: GET
        description: List stored proxies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createstoreproxy
        method: POST
        description: Create stored proxy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-store-proxies-name
      path: /api/store/proxies/{name}
      operations:
      - name: getstoreproxy
        method: GET
        description: Get stored proxy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Stored proxy name
          required: true
      - name: updatestoreproxy
        method: PUT
        description: Update stored proxy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Stored proxy name
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletestoreproxy
        method: DELETE
        description: Delete stored proxy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Stored proxy name
          required: true
    - name: api-store-visitors
      path: /api/store/visitors
      operations:
      - name: liststorevisitors
        method: GET
        description: List stored visitors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createstorevisitor
        method: POST
        description: Create stored visitor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-store-visitors-name
      path: /api/store/visitors/{name}
      operations:
      - name: getstorevisitor
        method: GET
        description: Get stored visitor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Stored visitor name
          required: true
      - name: updatestorevisitor
        method: PUT
        description: Update stored visitor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Stored visitor name
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletestorevisitor
        method: DELETE
        description: Delete stored visitor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Stored visitor name
          required: true
    authentication:
      type: basic
      username: '{{env.FRP_USER}}'
      password: '{{env.FRP_PASS}}'
  exposes:
  - type: rest
    namespace: client-admin-store-rest
    port: 8080
    description: REST adapter for frp Client Admin API — Store. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/store/proxies
      name: api-store-proxies
      description: REST surface for api-store-proxies.
      operations:
      - method: GET
        name: liststoreproxies
        description: List stored proxies
        call: client-admin-store.liststoreproxies
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createstoreproxy
        description: Create stored proxy
        call: client-admin-store.createstoreproxy
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/store/proxies/{name}
      name: api-store-proxies-name
      description: REST surface for api-store-proxies-name.
      operations:
      - method: GET
        name: getstoreproxy
        description: Get stored proxy
        call: client-admin-store.getstoreproxy
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatestoreproxy
        description: Update stored proxy
        call: client-admin-store.updatestoreproxy
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletestoreproxy
        description: Delete stored proxy
        call: client-admin-store.deletestoreproxy
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/store/visitors
      name: api-store-visitors
      description: REST surface for api-store-visitors.
      operations:
      - method: GET
        name: liststorevisitors
        description: List stored visitors
        call: client-admin-store.liststorevisitors
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createstorevisitor
        description: Create stored visitor
        call: client-admin-store.createstorevisitor
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/store/visitors/{name}
      name: api-store-visitors-name
      description: REST surface for api-store-visitors-name.
      operations:
      - method: GET
        name: getstorevisitor
        description: Get stored visitor
        call: client-admin-store.getstorevisitor
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatestorevisitor
        description: Update stored visitor
        call: client-admin-store.updatestorevisitor
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletestorevisitor
        description: Delete stored visitor
        call: client-admin-store.deletestorevisitor
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: client-admin-store-mcp
    port: 9090
    transport: http
    description: MCP adapter for frp Client Admin API — Store. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-stored-proxies
      description: List stored proxies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: client-admin-store.liststoreproxies
      outputParameters:
      - type: object
        mapping: $.
    - name: create-stored-proxy
      description: Create stored proxy
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: client-admin-store.createstoreproxy
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-stored-proxy
      description: Get stored proxy
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: client-admin-store.getstoreproxy
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-stored-proxy
      description: Update stored proxy
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: client-admin-store.updatestoreproxy
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-stored-proxy
      description: Delete stored proxy
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: client-admin-store.deletestoreproxy
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: list-stored-visitors
      description: List stored visitors
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: client-admin-store.liststorevisitors
      outputParameters:
      - type: object
        mapping: $.
    - name: create-stored-visitor
      description: Create stored visitor
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: client-admin-store.createstorevisitor
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-stored-visitor
      description: Get stored visitor
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: client-admin-store.getstorevisitor
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-stored-visitor
      description: Update stored visitor
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: client-admin-store.updatestorevisitor
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-stored-visitor
      description: Delete stored visitor
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: client-admin-store.deletestorevisitor
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.