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 for React/Next.js interaction effects by name or category, with free/pro tier details.

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

TableJSON 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', '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. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, and the description adds valuable behavioral context: the response includes total/count/has_more/next_offset, tier filtering must be done client-side, and per-item calls are unnecessary for totals. This goes beyond the structured annotations without contradicting them.

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

Conciseness5/5

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

The description is long but organized and every section earns its place: purpose, return shape, examples, and explicit exclusions. Important guidance (tier counting, avoid per-item calls) is front-loaded, and the 'Don't use when' clause is a strong disambiguation that prevents costly mistakes.

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?

With no output schema, the description compensates by declaring the exact JSON return shape, pagination fields, and the tier field. It also covers parameter selection, category validation via a sibling tool, and when to delegate to hyperiux_get_effect, making the tool fully self-contained for correct invocation.

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 description coverage is 100%, so the baseline is 3; the description largely restates parameter defaults and meanings. However, it adds practical usage semantics through examples (e.g., 'What cursor effects are available?' -> category='cursor') and guidance to size limit by checking total/has_more for counting questions, which helps agents use the parameters correctly.

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?

The description states a specific verb ('Browse or search') and resource ('Hyperiux Vault catalog of React/Next.js interaction effects'), and lists concrete effect types. It also explicitly distinguishes itself from hyperiux_get_effect, so an agent can pick the right tool without ambiguity.

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?

The description explains when to use this tool (browsing/searching, counting free/pro tiers) and when not to use it, naming the alternative hyperiux_get_effect for full effect details. It also provides concrete examples mapping questions to parameters and points to hyperiux_list_categories for valid category values.

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