Ampersand public API — Provider App

naftiko: 1.0.0-alpha2
info:
  label: Ampersand public API — Provider App
  description: 'Ampersand public API — Provider App. 4 operations. Lead operation: Ampersand List Provider Apps. Self-contained
    Naftiko capability covering one Ampersand business surface.'
  tags:
  - Ampersand
  - Provider App
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AMPERSAND_API_KEY: AMPERSAND_API_KEY
capability:
  consumes:
  - type: http
    namespace: ampersand-provider-app
    baseUri: https://api.withampersand.com/v1
    description: Ampersand public API — Provider App business capability. Self-contained, no shared references.
    resources:
    - name: projects-projectIdOrName-provider-apps
      path: /projects/{projectIdOrName}/provider-apps
      operations:
      - name: listproviderapps
        method: GET
        description: Ampersand List Provider Apps
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: TThe Ampersand project ID or project name.
          required: true
      - name: createproviderapp
        method: POST
        description: Ampersand Create a New Provider App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-projectIdOrName-provider-apps-providerAppId
      path: /projects/{projectIdOrName}/provider-apps/{providerAppId}
      operations:
      - name: deleteproviderapp
        method: DELETE
        description: Ampersand Delete a Provider App.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: providerAppId
          in: path
          type: string
          description: ID of the provider app, returned by the CreateProviderApp call.
          required: true
      - name: updateproviderapp
        method: PATCH
        description: Ampersand Update a Provider App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectIdOrName
          in: path
          type: string
          description: The Ampersand project ID or project name.
          required: true
        - name: providerAppId
          in: path
          type: string
          description: ID of the provider app, returned by the CreateProviderApp call.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.AMPERSAND_API_KEY}}'
  exposes:
  - type: rest
    namespace: ampersand-provider-app-rest
    port: 8080
    description: REST adapter for Ampersand public API — Provider App. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{projectidorname}/provider-apps
      name: projects-projectidorname-provider-apps
      description: REST surface for projects-projectIdOrName-provider-apps.
      operations:
      - method: GET
        name: listproviderapps
        description: Ampersand List Provider Apps
        call: ampersand-provider-app.listproviderapps
        with:
          projectIdOrName: rest.projectIdOrName
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createproviderapp
        description: Ampersand Create a New Provider App
        call: ampersand-provider-app.createproviderapp
        with:
          projectIdOrName: rest.projectIdOrName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectidorname}/provider-apps/{providerappid}
      name: projects-projectidorname-provider-apps-providerappid
      description: REST surface for projects-projectIdOrName-provider-apps-providerAppId.
      operations:
      - method: DELETE
        name: deleteproviderapp
        description: Ampersand Delete a Provider App.
        call: ampersand-provider-app.deleteproviderapp
        with:
          projectIdOrName: rest.projectIdOrName
          providerAppId: rest.providerAppId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateproviderapp
        description: Ampersand Update a Provider App
        call: ampersand-provider-app.updateproviderapp
        with:
          projectIdOrName: rest.projectIdOrName
          providerAppId: rest.providerAppId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ampersand-provider-app-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ampersand public API — Provider App. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: ampersand-list-provider-apps
      description: Ampersand List Provider Apps
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ampersand-provider-app.listproviderapps
      with:
        projectIdOrName: tools.projectIdOrName
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-create-new-provider-app
      description: Ampersand Create a New Provider App
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ampersand-provider-app.createproviderapp
      with:
        projectIdOrName: tools.projectIdOrName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-delete-provider-app
      description: Ampersand Delete a Provider App.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ampersand-provider-app.deleteproviderapp
      with:
        projectIdOrName: tools.projectIdOrName
        providerAppId: tools.providerAppId
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-update-provider-app
      description: Ampersand Update a Provider App
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ampersand-provider-app.updateproviderapp
      with:
        projectIdOrName: tools.projectIdOrName
        providerAppId: tools.providerAppId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.