Plausible Sites API — CustomProps

naftiko: 1.0.0-alpha2
info:
  label: Plausible Sites API — CustomProps
  description: 'Plausible Sites API — CustomProps. 3 operations. Lead operation: List custom properties. Self-contained Naftiko
    capability covering one Plausible business surface.'
  tags:
  - Plausible
  - CustomProps
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PLAUSIBLE_API_KEY: PLAUSIBLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: sites-customprops
    baseUri: https://plausible.io
    description: Plausible Sites API — CustomProps business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-sites-custom-props
      path: /api/v1/sites/custom-props
      operations:
      - name: listcustomprops
        method: GET
        description: List custom properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcustomprop
        method: PUT
        description: Create custom property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-sites-custom-props-property
      path: /api/v1/sites/custom-props/{property}
      operations:
      - name: deletecustomprop
        method: DELETE
        description: Delete custom property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.PLAUSIBLE_API_KEY}}'
  exposes:
  - type: rest
    namespace: sites-customprops-rest
    port: 8080
    description: REST adapter for Plausible Sites API — CustomProps. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/sites/custom-props
      name: api-v1-sites-custom-props
      description: REST surface for api-v1-sites-custom-props.
      operations:
      - method: GET
        name: listcustomprops
        description: List custom properties
        call: sites-customprops.listcustomprops
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: createcustomprop
        description: Create custom property
        call: sites-customprops.createcustomprop
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/sites/custom-props/{property}
      name: api-v1-sites-custom-props-property
      description: REST surface for api-v1-sites-custom-props-property.
      operations:
      - method: DELETE
        name: deletecustomprop
        description: Delete custom property
        call: sites-customprops.deletecustomprop
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sites-customprops-mcp
    port: 9090
    transport: http
    description: MCP adapter for Plausible Sites API — CustomProps. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-custom-properties
      description: List custom properties
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sites-customprops.listcustomprops
      outputParameters:
      - type: object
        mapping: $.
    - name: create-custom-property
      description: Create custom property
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sites-customprops.createcustomprop
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-custom-property
      description: Delete custom property
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sites-customprops.deletecustomprop
      outputParameters:
      - type: object
        mapping: $.