Hypixel Public API — Resources

naftiko: 1.0.0-alpha2
info:
  label: Hypixel Public API — Resources
  description: 'Resources surface of the Hypixel Public API. 7 operations. Lead operation: Hypixel Game Information. Self-contained
    Naftiko capability covering one Hypixel business surface.'
  tags:
  - Hypixel
  - Gaming
  - Minecraft
  - Resources
  created: '2026-05-30'
  modified: '2026-05-30'
binds:
- namespace: env
  keys:
    HYPIXEL_API_KEY: HYPIXEL_API_KEY
capability:
  consumes:
  - type: http
    namespace: hypixel-public-api-resources
    baseUri: https://api.hypixel.net/v2
    description: Hypixel Public API — Resources business capability. Self-contained, no shared references.
    authentication:
      type: apikey
      key: API-Key
      value: '{{env.HYPIXEL_API_KEY}}'
      placement: header
    resources:
    - name: v2-resources-games
      path: /resources/games
      operations:
      - name: getResourcesGames
        method: GET
        description: Hypixel Game Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-resources-achievements
      path: /resources/achievements
      operations:
      - name: getResourcesAchievements
        method: GET
        description: Hypixel Achievements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-resources-challenges
      path: /resources/challenges
      operations:
      - name: getResourcesChallenges
        method: GET
        description: Hypixel Challenges
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-resources-quests
      path: /resources/quests
      operations:
      - name: getResourcesQuests
        method: GET
        description: Hypixel Quests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-resources-guilds-achievements
      path: /resources/guilds/achievements
      operations:
      - name: getResourcesGuildsAchievements
        method: GET
        description: Hypixel Guild Achievements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-resources-vanity-pets
      path: /resources/vanity/pets
      operations:
      - name: getResourcesVanityPets
        method: GET
        description: Hypixel Vanity Pets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-resources-vanity-companions
      path: /resources/vanity/companions
      operations:
      - name: getResourcesVanityCompanions
        method: GET
        description: Hypixel Vanity Companions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: hypixel-public-api-resources-rest
    port: 8080
    description: REST adapter for Hypixel Public API — Resources. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/resources/games
      name: v2-resources-games
      description: REST surface for /v2/resources/games.
      operations:
      - method: GET
        name: getResourcesGames
        description: Hypixel Game Information
        call: hypixel-public-api-resources.getResourcesGames
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/achievements
      name: v2-resources-achievements
      description: REST surface for /v2/resources/achievements.
      operations:
      - method: GET
        name: getResourcesAchievements
        description: Hypixel Achievements
        call: hypixel-public-api-resources.getResourcesAchievements
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/challenges
      name: v2-resources-challenges
      description: REST surface for /v2/resources/challenges.
      operations:
      - method: GET
        name: getResourcesChallenges
        description: Hypixel Challenges
        call: hypixel-public-api-resources.getResourcesChallenges
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/quests
      name: v2-resources-quests
      description: REST surface for /v2/resources/quests.
      operations:
      - method: GET
        name: getResourcesQuests
        description: Hypixel Quests
        call: hypixel-public-api-resources.getResourcesQuests
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/guilds/achievements
      name: v2-resources-guilds-achievements
      description: REST surface for /v2/resources/guilds/achievements.
      operations:
      - method: GET
        name: getResourcesGuildsAchievements
        description: Hypixel Guild Achievements
        call: hypixel-public-api-resources.getResourcesGuildsAchievements
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/vanity/pets
      name: v2-resources-vanity-pets
      description: REST surface for /v2/resources/vanity/pets.
      operations:
      - method: GET
        name: getResourcesVanityPets
        description: Hypixel Vanity Pets
        call: hypixel-public-api-resources.getResourcesVanityPets
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resources/vanity/companions
      name: v2-resources-vanity-companions
      description: REST surface for /v2/resources/vanity/companions.
      operations:
      - method: GET
        name: getResourcesVanityCompanions
        description: Hypixel Vanity Companions
        call: hypixel-public-api-resources.getResourcesVanityCompanions
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: hypixel-public-api-resources-mcp
    port: 9090
    transport: http
    description: MCP adapter for Hypixel Public API — Resources. One verb-noun tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: game-information
      description: Hypixel Game Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hypixel-public-api-resources.getResourcesGames
      outputParameters:
      - type: object
        mapping: $.
    - name: achievements
      description: Hypixel Achievements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hypixel-public-api-resources.getResourcesAchievements
      outputParameters:
      - type: object
        mapping: $.
    - name: challenges
      description: Hypixel Challenges
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hypixel-public-api-resources.getResourcesChallenges
      outputParameters:
      - type: object
        mapping: $.
    - name: quests
      description: Hypixel Quests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hypixel-public-api-resources.getResourcesQuests
      outputParameters:
      - type: object
        mapping: $.
    - name: guild-achievements
      description: Hypixel Guild Achievements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hypixel-public-api-resources.getResourcesGuildsAchievements
      outputParameters:
      - type: object
        mapping: $.
    - name: vanity-pets
      description: Hypixel Vanity Pets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hypixel-public-api-resources.getResourcesVanityPets
      outputParameters:
      - type: object
        mapping: $.
    - name: vanity-companions
      description: Hypixel Vanity Companions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hypixel-public-api-resources.getResourcesVanityCompanions
      outputParameters:
      - type: object
        mapping: $.