How do I install the Ag UI skill?

Run npx skillmds@latest add tomevault-io/ag-ui in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Ag UI safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Ag UI?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Ag UI free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Ag UI by tomevault-io — Agent Skill

Name: Ag UI
Author: tomevault-io

Ag UI

AG-UI protocol implementation guidance for event ordering (`RUN_STARTED`, `TOOL_CALL_*`, `STATE_SNAPSHOT`/`STATE_DELTA`), streaming semantics, and middleware patterns. Use when integrating agent backends with AG-UI clients. Use when this capability is needed.

tomevault-io 4bb9a23 2 files · 3.1 KB Updated Sep 17, 2026

File contents

AG-UI

Use this skill to implement AG-UI compliant integrations with correct event ordering, tool lifecycle behavior, and state synchronization semantics.

Quick Triage

Use this skill when the task is protocol-level integration between agent backend and UI client.
Switch to $langgraph when graph orchestration/checkpoint logic is the primary issue.
Switch to $langchain when chain or tool orchestration internals are the primary issue.
Switch to $copilotkit when CopilotKit hooks/provider behavior is primary.

Workflow

Define integration mode. Choose client-side HttpAgent, custom AbstractAgent, or middleware bridge.
Lock event subset and ordering. Map required lifecycle, text, tool, and state events before implementation.
Implement lifecycle first. Guarantee RUN_STARTED and RUN_FINISHED/RUN_ERROR framing around all runs.
Implement message and tool streams. Ensure tool call start/args/end/result sequence is valid and complete.
Implement state synchronization. Choose snapshot-only, delta-only, or hybrid strategy intentionally.
Add middleware with explicit order. Enforce auth, filtering, and logging without mutating protocol invariants.
Validate against event traces. Use deterministic replay to confirm ordering and payload shape.

Default Patterns

Emit minimal valid event streams rather than custom ad-hoc payloads.
Keep tool result payloads parseable and bounded.
Prefer explicit event schemas over inferred client parsing.
Keep protocol payloads transport-agnostic.

Failure Modes

Out-of-order lifecycle or tool events.
Partial tool-call streams without terminal result events.
State delta application mismatch on client.
Middleware mutating payloads into non-compliant shapes.

Reference Map

Load only what is needed for the current subtask.

Event contracts: references/event-contracts.md
State sync strategy: references/state-sync.md
Middleware usage: references/middleware-patterns.md
Integration checklist: references/integration-checklist.md

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: ag-uidescription: AG-UI protocol implementation guidance for event ordering (`RUN_STARTED`, `TOOL_CALL_*`, `STATE_SNAPSHOT`/`STATE_DELTA`), streaming semantics, and middleware patterns. Use when integrating agent backends with AG-UI clients. Use when this capability is needed.---# AG-UIUse this skill to implement AG-UI compliant integrations with correct event ordering, tool lifecycle behavior, and state synchronization semantics.## Quick Triage- Use this skill when the task is protocol-level integration between agent backend and UI client.- Switch to `$langgraph` when graph orchestration/checkpoint logic is the primary issue.- Switch to `$langchain` when chain or tool orchestration internals are the primary issue.- Switch to `$copilotkit` when CopilotKit hooks/provider behavior is primary.## Workflow1. Define integration mode.Choose client-side `HttpAgent`, custom `AbstractAgent`, or middleware bridge.2. Lock event subset and ordering.Map required lifecycle, text, tool, and state events before implementation.3. Implement lifecycle first.Guarantee `RUN_STARTED` and `RUN_FINISHED/RUN_ERROR` framing around all runs.4. Implement message and tool streams.Ensure tool call start/args/end/result sequence is valid and complete.5. Implement state synchronization.Choose snapshot-only, delta-only, or hybrid strategy intentionally.6. Add middleware with explicit order.Enforce auth, filtering, and logging without mutating protocol invariants.7. Validate against event traces.Use deterministic replay to confirm ordering and payload shape.## Default Patterns- Emit minimal valid event streams rather than custom ad-hoc payloads.- Keep tool result payloads parseable and bounded.- Prefer explicit event schemas over inferred client parsing.- Keep protocol payloads transport-agnostic.## Failure Modes- Out-of-order lifecycle or tool events.- Partial tool-call streams without terminal result events.- State delta application mismatch on client.- Middleware mutating payloads into non-compliant shapes.## Reference MapLoad only what is needed for the current subtask.- Event contracts: `references/event-contracts.md`- State sync strategy: `references/state-sync.md`- Middleware usage: `references/middleware-patterns.md`- Integration checklist: `references/integration-checklist.md`---> Converted and distributed by [TomeVault](https://tomevault.io/claim/outlinedriven) — claim your Tome and manage your conversions.

Frequently asked questions