Ampersand public API — Project

naftiko: 1.0.0-alpha2
info:
  label: Ampersand public API — Project
  description: 'Ampersand public API — Project. 4 operations. Lead operation: Ampersand List Projects. Self-contained Naftiko
    capability covering one Ampersand business surface.'
  tags:
  - Ampersand
  - Project
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AMPERSAND_API_KEY: AMPERSAND_API_KEY
capability:
  consumes:
  - type: http
    namespace: ampersand-project
    baseUri: https://api.withampersand.com/v1
    description: Ampersand public API — Project business capability. Self-contained, no shared references.
    resources:
    - name: projects
      path: /projects
      operations:
      - name: listprojects
        method: GET
        description: Ampersand List Projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createproject
        method: POST
        description: Ampersand Create a New Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-projectIdOrName
      path: /projects/{projectIdOrName}
      operations:
      - name: getproject
        method: GET
        description: Ampersand Get a Project
        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: includeEntitlements
          in: query
          type: boolean
          description: If true, the response includes the project's entitlements (plan-based feature flags). Defaults to false.
      - name: updateproject
        method: PATCH
        description: Ampersand Update a Project
        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
    authentication:
      type: bearer
      token: '{{env.AMPERSAND_API_KEY}}'
  exposes:
  - type: rest
    namespace: ampersand-project-rest
    port: 8080
    description: REST adapter for Ampersand public API — Project. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects
      name: projects
      description: REST surface for projects.
      operations:
      - method: GET
        name: listprojects
        description: Ampersand List Projects
        call: ampersand-project.listprojects
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createproject
        description: Ampersand Create a New Project
        call: ampersand-project.createproject
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectidorname}
      name: projects-projectidorname
      description: REST surface for projects-projectIdOrName.
      operations:
      - method: GET
        name: getproject
        description: Ampersand Get a Project
        call: ampersand-project.getproject
        with:
          projectIdOrName: rest.projectIdOrName
          includeEntitlements: rest.includeEntitlements
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateproject
        description: Ampersand Update a Project
        call: ampersand-project.updateproject
        with:
          projectIdOrName: rest.projectIdOrName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ampersand-project-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ampersand public API — Project. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: ampersand-list-projects
      description: Ampersand List Projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ampersand-project.listprojects
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-create-new-project
      description: Ampersand Create a New Project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ampersand-project.createproject
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-get-project
      description: Ampersand Get a Project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ampersand-project.getproject
      with:
        projectIdOrName: tools.projectIdOrName
        includeEntitlements: tools.includeEntitlements
      outputParameters:
      - type: object
        mapping: $.
    - name: ampersand-update-project
      description: Ampersand Update a Project
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ampersand-project.updateproject
      with:
        projectIdOrName: tools.projectIdOrName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.