cixzhang

mdx-a2ui: Convert MDX to A2UI JSON

mdx-a2ui converts prose and approved components in MDX into A2UI JSON without evaluating the source. It is an experimental option for agents or tools that author MDX but need structured output for A2UI renderers.

MITAI AgentsAILibrary
View on GitHub Compare
Stars
3
Forks
0
Stars, last 8 days
+0

Our take

Health score

20/100

How it is scored
Activity
32
Community
4
Issues
21
Pull requests
21

+0 stars in the last 8 days

  • Fewer contributors than 92% of the projects we track

Overview

mdx-a2ui is a converter for turning MDX documents into A2UI JSON. It is aimed at workflows where an agent authors a mix of prose and interactive components, while the resulting interface data needs to follow A2UI's structured format.

Unlike compiling MDX, the converter parses the source and accepts component attributes only when expressions parse as JSON literals. This makes it relevant when executing model-authored documents is not acceptable, and when the output should be usable by A2UI renderers rather than tied to a web runtime.

Key Features

  • Converts MDX prose and components from a closed catalog into A2UI JSON.
  • Parses source instead of evaluating MDX as code.
  • Accepts attribute expressions only when they parse as JSON literals.
  • Includes a repair step for MDX that is still streaming, as shown in the project workflow.
  • Produces output for A2UI renderers.
  • Marks exports with an experimental_ prefix.

Use Cases

  • An AI agent can author prose with selected UI components, then pass structured A2UI output to a renderer.
  • Teams can avoid executing model-authored MDX when converting generated interface content.
  • Developers building A2UI workflows can use MDX as a more prose-friendly authoring format.
  • Streaming generation pipelines can repair incomplete MDX before conversion.

Getting Started

The project is not published to npm, and the README does not provide an installation command. See the repository README for the project workflow and further details.

Considerations

This project is explicitly experimental: its exports and component catalog are not stable, and its target is A2UI v0.9. The README describes a closed component catalog but does not list its components or provide installation and usage instructions. It is not published to npm, so it may require using the repository directly.

Found this useful?

Share it with someone who would like mdx-a2ui.