Skip to main content
Glama
Hyperiux-Immersion-Labs

Hyperiux MCP Server

Official

List Hyperiux Vault Effects

hyperiux_list_effects
Read-onlyIdempotent

Browse or search the Hyperiux Vault catalog of React/Next.js interaction effects (scroll systems, cursor trails, WebGL scenes, animated buttons, page transitions, etc).

Instructions

Browse or search the Hyperiux Vault catalog of React/Next.js interaction effects (scroll systems, cursor trails, WebGL scenes, animated buttons, page transitions, etc).

Each result includes tier ("free" or "pro") - use this to answer "how many free/pro effects are there" or "which of these are free" directly from one call, by filtering/counting the returned list yourself. Don't estimate or guess these counts, and don't call hyperiux_get_effect per-item just to total them up - it's unnecessary here. hyperiux_get_effect is still the right call for one specific effect's full description/props/changelog.

Args:

  • query (string, optional): substring match against effect name

  • category (string, optional): filter to one category slug

  • limit (number, default 30, max 100)

  • offset (number, default 0)

Returns JSON: { total, count, offset, effects: [{ name, category, categories, dependencies, version, tier }], has_more, next_offset? }

Examples:

  • "What cursor effects are available?" -> category="cursor"

  • "Is there anything with 'particles' in the name?" -> query="particles"

  • "How many free effects are there?" -> call with a limit high enough to cover total (check total/has_more first), then count tier === "free" yourself.

  • Don't use when: you need one effect's full description/props/changelog - use hyperiux_get_effect instead.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum results to return.
queryNoCase-insensitive substring match against effect name (e.g. 'cursor', 'text-reveal'). Omit to list all.
offsetNoNumber of results to skip for pagination.
categoryNoFilter to one category, e.g. 'text', 'cursor', 'scroll', 'webgl', 'buttons', 'carousels', 'components', 'navigation', 'backgrounds', 'loaders', 'transitions'. Use hyperiux_list_categories to see all valid values with counts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedInput schema / properties / category / description
      Previous value: -"Filter to one category, e.g. 'text', 'cursor', 'webgl', 'buttons', 'carousels', 'components', 'navigation', 'backgrounds', 'loaders', 'transitions'. Use hyperiux_list_categories to see all valid values with counts."New value: +"Filter to one category, e.g. 'text', 'cursor', 'scroll', 'webgl', 'buttons', 'carousels', 'components', 'navigation', 'backgrounds', 'loaders', 'transitions'. Use hyperiux_list_categories to see all valid values with counts."
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint and openWorldHint, so the safety profile is covered; the description adds the return payload shape (total/count/has_more/next_offset) and pagination behavior, which is valuable since no output schema exists. It stops short of noting catalog freshness or rate limits, so it is strong but not exhaustive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded purpose followed by labeled Args/Returns/Examples blocks, which is easy for an agent to parse. Slightly verbose in the repeated warnings about not calling hyperiux_get_effect to count, but each block is functional.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only list tool with no output schema, the description supplies the return field list, pagination semantics, and the tier-based counting caveat an agent needs to answer aggregate questions correctly. Nothing required to call it or interpret results is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description goes beyond it by pairing each parameter with a real intent example (category='cursor', query='particles') and explaining the limit/has_more interaction needed for counting. It does not restate defaults or bounds already in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb+resource pair ('Browse or search the Hyperiux Vault catalog of React/Next.js interaction effects') and enumerates the effect types covered. It clearly separates this list/search operation from hyperiux_get_effect, so an agent can route without reading schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit routing guidance: use this for aggregate counts and tier filtering, do not call hyperiux_get_effect per-item to total them, and 'Don't use when' names the sibling that handles single-effect detail. The three intent-to-argument examples make the mapping concrete.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.