Skip to content
Mercury
English
  • English
  • Русский — скоро
Design Book
Menu
English
  • English
  • Русский — скоро

Mercury API reference

Mercury is a browser interface system: Hyperscript renders components, Mercury UI supplies components and CSS tokens, Hypergraph models state, and the native Rust mx CLI builds applications. This is the official entry point to Mercury's authored API documentation. Each linked chapter explains its current behavior and limits; a complete source-generated symbol reference is still planned.

JavaScript APIs

API Read first Contract and examples
@fiberfx/hyperscript Hyperscript DOM rendering, JSX, component functions and hooks
@fiberfx/ui Mercury UI Components, CSS tokens and themes
@fiberfx/hypergraph Hypergraph store, event and effect, graph wiring and scopes
@fiberfx/content Content Documents, block catalogs and rendering

Import hooks from @fiberfx/hyperscript/hooks. Use native DOM attributes such as class and for. The browser guide includes an executable Card and Button example with pinned packages and the required stylesheet.

import { h, render } from "@fiberfx/hyperscript";
import { Button } from "@fiberfx/ui";

render(h(Button, { onClick: () => console.log("Clicked") }, "Try Mercury"),
  document.getElementById("app"));

The host must be empty before mounting; repeated render calls append to it. Load the Mercury UI stylesheet as described in the browser guide.

Read the Reflect 4.1.1 course for reflect, createReflect, list, variant and fromTag, with live binding/composition exercises and agent companions.

Native mx CLI

Read mx CLI documentation, installation and platform readiness, the first application, development server and build commands. Native mx is a Rust binary; JavaScript is what runs in the browser. Follow the installation page for the current npm launcher and direct-archive status.

Optional server integration

Live Mercury integrates Mercury islands with Phoenix and LiveView. A browser-only application does not require Elixir or BEAM. Module-specific readiness is recorded in stability.

Public HTTP API

The API index lists the service URLs. The OpenAPI 3.1 description documents the existing HTTP resources:

  • GET /api: discovery URLs and the public access policy.
  • GET /downloads.json: verified release metadata. An empty artifacts object means no downloadable release is currently published.
  • GET /mcp/server-card: experimental MCP discovery metadata.
  • POST /mcp: the read-only Mercury documentation MCP server, with skills, mx platform guidance and component reading prompts.

These public resources require no account or API key. MCP uses JSON-RPC with its own initialization and discovery methods; use an MCP client and the connection guide. Its HTTP errors retain JSON-RPC envelopes. Unknown paths under /api return HTTP 404 with application/problem+json (RFC 9457); unsupported methods on the index return 405 with Allow: GET, HEAD. Ordinary documentation pages retain their HTML and Markdown representations.

curl https://mercury.jonnify.com/api
curl https://mercury.jonnify.com/openapi.json

Read with an agent

Request this URL with Accept: text/markdown, read its concise companion, or start with the Mercury skill. The public Mercury distribution repository contains release instructions, documentation bundles and agent workflows. The FiberFX organization owns that repository.