Skip to main content
Glama

Hero Metric

render_hero_metric
Read-onlyIdempotent

Render a hero metric widget to answer key questions: big numbers, progress rings, status, comparisons, ranks, countdowns, thresholds, breakdowns, NPS, orbs, and gems.

Instructions

Render a purpose-driven hero metric widget. Pick the variant that answers your question:

  • big_number: 'How much? Which direction?' Default hero metric - clean, professional, works in any context. Large value + trend arrow + optional sparkline. Params: value, unit, change, changePeriod, sparkline[]

  • progress_ring: 'How close to goal?' Animated ring or half-gauge. Params: value, unit, label, progress (0-100), style ('ring'|'gauge'), size, color

  • status: 'Good or bad?' Pulsing dot + subsystem badges. Params: label, statusLevel ('good'|'warn'|'bad'), subsystems[{name,status}], count, peak

  • comparison: 'How do we compare?' Before/after + improvement. Params: before, after, improvement, beforeLabel, afterLabel

  • rank: 'Where do I stand?' Badge + percentile. Params: rank, total, percentile, rankChange

  • countdown: 'How long left?' Time segment boxes. Params: segments[{value,label}] OR deadline (ISO date)

  • threshold: 'Above or below limit?' Gradient bar + marker. Params: value, max, threshold, unit, zones[{label,from,to,color}]

  • breakdown: 'What is the split?' Stacked bar + legend. Params: items[{label,value,color?}]

  • nps: 'How satisfied?' Score + rating scale. Params: value, max (default 100), rating ('good'|'neutral'|'bad')

  • orb: 'What is the headline?' Dramatic glowing sphere. Use golden orb for resumes/portfolios. For tech meetings use only black, white, or crystal-colored orbs as subtle flair. Best with dark themes (tokyo-midnight, ops-control, startup). Avoid for formal contexts (boardroom, clinical, consultant). Params: value, unit, label, color

  • gem: 'Premium gem metric' Faceted/spherical gem - for wealth, fintech, trading, crypto, luxury contexts ONLY. Best with golden-treasury, tokyo-midnight themes. Do NOT use for corporate, clinical, consultant, or boardroom dashboards - use big_number instead. Params: value, unit, label, gemType. gemTypes: crystal='Future' (forecasts, projections) | black_pearl='Rare find' (alt investments, crypto) | golden_pearl='Treasure' (gold, commodities) | white_pearl='Clean total' (savings) diamond='Crown number' (net worth, total revenue) | ruby='What's critical' (urgent, burn rate) | sapphire='Foundation' (stability, uptime) | emerald='Growth' (YoY, appreciation)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
maxNoMaximum value for threshold/nps
peakNoPeak count
rankNoCurrent rank
sizeNoSize: sm/md/lg/xl
unitNoUnit label (e.g. 'grams', '%', 'USD')
afterNoAfter value
colorNoOverride accent color (hex)
countNoLive count
itemsNoBreakdown items
labelNoSub-label
styleNoprogress_ring style
themeNoTheme preset: boardroom, corporate, sales-floor, golden-treasury, clinical, startup, ops-control, tokyo-midnight, zen-garden, consultant, black-tron, black-elegance, black-matrix, forest-amber, forest-earth, sky-light, sky-ocean, sky-twilight, gray-hf, gray-copilot, office-red
titleYesChart title
totalNoTotal in ranking
valueNoMain metric value
zonesNoColor zones
beforeNoBefore value
changeNoPercentage change
ratingNoNPS rating override
effectsNoOverride effects: none, subtle, shimmer, neon, energetic
gemTypeNoGem type for variant=gem: diamond, ruby, sapphire, emerald, golden_pearl, white_pearl, black_pearl, crystal
paletteNoOverride palette only (mix-and-match)
variantNoWidget variant (default: big_number)
deadlineNoISO deadline date
progressNoRing fill 0-100
segmentsNoTime segments
sparklineNoMini bar sparkline data
thresholdNoThreshold limit line
afterLabelNoAfter column label
percentileNoPercentile
rankChangeNoPositions moved
subsystemsNoSubsystem badges
typographyNoOverride typography: professional, luxury, cyberpunk, editorial, mono, bold, system, techno
beforeLabelNoBefore column label
improvementNoImprovement label
statusLevelNoStatus level
changePeriodNoPeriod label for change (e.g. 'vs last month')

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv2.4.1
    • removedInput schema / properties / after / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "number"
      -  }
      -]
    • addedInput schema / properties / after / type
      Added value: +[
      +  "string",
      +  "number"
      +]
    • removedInput schema / properties / before / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "number"
      -  }
      -]
    • addedInput schema / properties / before / type
      Added value: +[
      +  "string",
      +  "number"
      +]
    • removedInput schema / properties / improvement / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "number"
      -  }
      -]
    • addedInput schema / properties / improvement / type
      Added value: +[
      +  "string",
      +  "number"
      +]
    • removedInput schema / properties / value / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "number"
      -  }
      -]
    • addedInput schema / properties / value / type
      Added value: +[
      +  "string",
      +  "number"
      +]
  2. Changed1 schema field changedv2.2.0
    • changedInput schema / properties / theme / description
      Previous value: -"Theme preset: boardroom, corporate, sales-floor, golden-treasury, clinical, startup, ops-control, tokyo-midnight, zen-garden, consultant, black-tron, black-elegance, black-matrix, forest-amber, forest-earth, sky-light, sky-ocean, sky-twilight, gray-hf, gray-copilot"New value: +"Theme preset: boardroom, corporate, sales-floor, golden-treasury, clinical, startup, ops-control, tokyo-midnight, zen-garden, consultant, black-tron, black-elegance, black-matrix, forest-amber, forest-earth, sky-light, sky-ocean, sky-twilight, gray-hf, gray-copilot, office-red"
  3. Addedv2.1.0
  4. Removedv1.0.1
  5. First observedv1.0.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description still adds substantial behavioral context: contextual appropriateness rules per variant, theme pairings (orb 'best with dark themes', gem 'best with golden-treasury, tokyo-midnight'), and a documented default (big_number). This is well beyond annotation coverage.

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?

Long, but every line is a variant-to-question-to-params lookup that earns its place, and it is front-loaded with the selection rule. Slightly dense with inline 'Params:' lists, though this structure is functional rather than wasteful.

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

Completeness4/5

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

For an 11-variant, 37-parameter tool with no output schema, the description covers variant choice and per-variant parameters thoroughly. It leaves shared/global params (theme, palette, typography, size, effects) unexplained, but those are covered by the schema.

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 adds real semantic value beyond it: it groups which params belong to which variant and explains the abstract gemType enum meanings (crystal='Future', ruby='What's critical', diamond='Crown number'). It does not cover shared params like theme, palette, typography, size or effects, so it is additive rather than complete.

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?

States a specific verb+resource ('Render a purpose-driven hero metric widget') and then enumerates all 11 variants with the question each answers. An agent can immediately tell this apart from sibling chart renderers like render_pie_chart or render_hero_catalog.

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?

Explicitly frames selection as 'Pick the variant that answers your question' and maps each variant to a decision question (How much? How close to goal? Good or bad?). Goes further with negative guidance: orb should avoid formal contexts, gem is 'for wealth, fintech, trading, crypto, luxury contexts ONLY' with an explicit fallback ('use big_number instead').

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