ClickUp Goals API — Goals

naftiko: 1.0.0-alpha2
info:
  label: ClickUp Goals API — Goals
  description: 'ClickUp Goals API — Goals. 8 operations. Lead operation: Get a goal. Self-contained Naftiko capability covering
    one Clickup business surface.'
  tags:
  - Clickup
  - Goals
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CLICKUP_API_KEY: CLICKUP_API_KEY
capability:
  consumes:
  - type: http
    namespace: goals-goals
    baseUri: https://api.clickup.com/api/v2
    description: ClickUp Goals API — Goals business capability. Self-contained, no shared references.
    resources:
    - name: goal-goal_id
      path: /goal/{goal_id}
      operations:
      - name: getgoal
        method: GET
        description: Get a goal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategoal
        method: PUT
        description: Update a goal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletegoal
        method: DELETE
        description: Delete a goal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: goal-goal_id-key_result
      path: /goal/{goal_id}/key_result
      operations:
      - name: createkeyresult
        method: POST
        description: Create a key result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: key_result-key_result_id
      path: /key_result/{key_result_id}
      operations:
      - name: editkeyresult
        method: PUT
        description: Edit a key result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletekeyresult
        method: DELETE
        description: Delete a key result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: team-team_id-goal
      path: /team/{team_id}/goal
      operations:
      - name: getgoals
        method: GET
        description: Get goals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_completed
          in: query
          type: boolean
          description: Include completed Goals in the response.
      - name: creategoal
        method: POST
        description: Create a goal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.CLICKUP_API_KEY}}'
  exposes:
  - type: rest
    namespace: goals-goals-rest
    port: 8080
    description: REST adapter for ClickUp Goals API — Goals. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/goal/{goal-id}
      name: goal-goal-id
      description: REST surface for goal-goal_id.
      operations:
      - method: GET
        name: getgoal
        description: Get a goal
        call: goals-goals.getgoal
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updategoal
        description: Update a goal
        call: goals-goals.updategoal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegoal
        description: Delete a goal
        call: goals-goals.deletegoal
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/goal/{goal-id}/key-result
      name: goal-goal-id-key-result
      description: REST surface for goal-goal_id-key_result.
      operations:
      - method: POST
        name: createkeyresult
        description: Create a key result
        call: goals-goals.createkeyresult
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/key-result/{key-result-id}
      name: key-result-key-result-id
      description: REST surface for key_result-key_result_id.
      operations:
      - method: PUT
        name: editkeyresult
        description: Edit a key result
        call: goals-goals.editkeyresult
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletekeyresult
        description: Delete a key result
        call: goals-goals.deletekeyresult
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/team/{team-id}/goal
      name: team-team-id-goal
      description: REST surface for team-team_id-goal.
      operations:
      - method: GET
        name: getgoals
        description: Get goals
        call: goals-goals.getgoals
        with:
          include_completed: rest.include_completed
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategoal
        description: Create a goal
        call: goals-goals.creategoal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: goals-goals-mcp
    port: 9090
    transport: http
    description: MCP adapter for ClickUp Goals API — Goals. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-goal
      description: Get a goal
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: goals-goals.getgoal
      outputParameters:
      - type: object
        mapping: $.
    - name: update-goal
      description: Update a goal
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: goals-goals.updategoal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-goal
      description: Delete a goal
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: goals-goals.deletegoal
      outputParameters:
      - type: object
        mapping: $.
    - name: create-key-result
      description: Create a key result
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: goals-goals.createkeyresult
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: edit-key-result
      description: Edit a key result
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: goals-goals.editkeyresult
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-key-result
      description: Delete a key result
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: goals-goals.deletekeyresult
      outputParameters:
      - type: object
        mapping: $.
    - name: get-goals
      description: Get goals
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: goals-goals.getgoals
      with:
        include_completed: tools.include_completed
      outputParameters:
      - type: object
        mapping: $.
    - name: create-goal
      description: Create a goal
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: goals-goals.creategoal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.