Mixpanel Annotations API — Annotations

naftiko: 1.0.0-alpha2
info:
  label: Mixpanel Annotations API — Annotations
  description: 'Mixpanel Annotations API — Annotations. 5 operations. Lead operation: Mixpanel List annotations. Self-contained
    Naftiko capability covering one Mixpanel business surface.'
  tags:
  - Mixpanel
  - Annotations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MIXPANEL_API_KEY: MIXPANEL_API_KEY
capability:
  consumes:
  - type: http
    namespace: annotations-annotations
    baseUri: https://mixpanel.com/api/app
    description: Mixpanel Annotations API — Annotations business capability. Self-contained, no shared references.
    resources:
    - name: projects-projectId-annotations
      path: /projects/{projectId}/annotations
      operations:
      - name: listannotations
        method: GET
        description: Mixpanel List annotations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from_date
          in: query
          type: string
          description: Start date filter (YYYY-MM-DD)
        - name: to_date
          in: query
          type: string
          description: End date filter (YYYY-MM-DD)
      - name: createannotation
        method: POST
        description: Mixpanel Create annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-projectId-annotations-annotationId
      path: /projects/{projectId}/annotations/{annotationId}
      operations:
      - name: getannotation
        method: GET
        description: Mixpanel Get annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateannotation
        method: PUT
        description: Mixpanel Update annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteannotation
        method: DELETE
        description: Mixpanel Delete annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.MIXPANEL_USER}}'
      password: '{{env.MIXPANEL_PASS}}'
  exposes:
  - type: rest
    namespace: annotations-annotations-rest
    port: 8080
    description: REST adapter for Mixpanel Annotations API — Annotations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{projectid}/annotations
      name: projects-projectid-annotations
      description: REST surface for projects-projectId-annotations.
      operations:
      - method: GET
        name: listannotations
        description: Mixpanel List annotations
        call: annotations-annotations.listannotations
        with:
          from_date: rest.from_date
          to_date: rest.to_date
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createannotation
        description: Mixpanel Create annotation
        call: annotations-annotations.createannotation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/annotations/{annotationid}
      name: projects-projectid-annotations-annotationid
      description: REST surface for projects-projectId-annotations-annotationId.
      operations:
      - method: GET
        name: getannotation
        description: Mixpanel Get annotation
        call: annotations-annotations.getannotation
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateannotation
        description: Mixpanel Update annotation
        call: annotations-annotations.updateannotation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteannotation
        description: Mixpanel Delete annotation
        call: annotations-annotations.deleteannotation
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: annotations-annotations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Mixpanel Annotations API — Annotations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: mixpanel-list-annotations
      description: Mixpanel List annotations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: annotations-annotations.listannotations
      with:
        from_date: tools.from_date
        to_date: tools.to_date
      outputParameters:
      - type: object
        mapping: $.
    - name: mixpanel-create-annotation
      description: Mixpanel Create annotation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: annotations-annotations.createannotation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: mixpanel-get-annotation
      description: Mixpanel Get annotation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: annotations-annotations.getannotation
      outputParameters:
      - type: object
        mapping: $.
    - name: mixpanel-update-annotation
      description: Mixpanel Update annotation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: annotations-annotations.updateannotation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: mixpanel-delete-annotation
      description: Mixpanel Delete annotation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: annotations-annotations.deleteannotation
      outputParameters:
      - type: object
        mapping: $.