aomi-build

name	aomi-build
description	Build new Aomi apps and plugins from API docs, OpenAPI/Swagger specs, SDK docs, runtime interfaces, or product requirements. aomi-build scaffolds production-ready Rust SDK crates (lib.rs, client.rs, tool.rs) with tool schemas, preambles, host-interop flows, and validation steps — turning a vendor's full API surface into AI-agent-callable tools. Trigger when the user wants to scaffold a new Aomi app from an OpenAPI/Swagger spec, wrap a REST API as agent-callable tools, port an existing SDK to Aomi, generate a tool surface from product requirements, or extend an Aomi runtime with new integrations. Prefers real product integrations over docs-only helpers whenever a callable surface exists. Output crates support sync HTTP, async tools (cancellation-safe via DynAsyncSink), proxy-unwrap (EIP-1967), and host-interop flows that route quote → approval → swap as multi-step transactions. Same runtime that aomi-transact drives.
compatibility	Best when a local `aomi-apps` checkout is available, often at `../aomi-apps`. Falls back to bundled references when the SDK repo is not present. Targets aomi-sdk v0.1.15+ (Rust 2024 edition).
license	MIT
allowed-tools	Bash, Read, Write, Edit, Grep
metadata	{"author":"aomi-labs","version":"0.1","repository":"aomi-labs/skills","homepage":"https://github.com/aomi-labs/skills/tree/main/aomi-build"}
permissions	{"files":{"read":["./","../aomi-apps/"],"write":["./apps/","./Cargo.toml","./Cargo.lock","./target/","../aomi-apps/apps/","../aomi-apps/Cargo.toml","../aomi-apps/Cargo.lock","../aomi-apps/target/"],"deny_write":["SOUL.md","MEMORY.md","AGENTS.md","build.rs"]},"network":{"allow":[],"deny":"*"},"shell":["cargo","git"],"tools":[]}
risk_tier	L1
requires	{"binaries":["cargo","git"]}

Aomi Build

Use this skill for tasks like:

• "Build an Aomi app from this OpenAPI spec."
• "Turn these REST endpoints into an Aomi plugin."
• "Scaffold a new Aomi SDK app for this product/API."
• "Update an existing Aomi app to support these new endpoints."
• "Turn these builder docs or SDK repos into an Aomi assistant."

First Read

If a local aomi-apps checkout exists (often at ../aomi-apps), inspect these first. The current SDK is v0.1.15, Rust 2024 edition, and apps live in the workspace's exclude = [...] list discovered via git ls-files apps/*/Cargo.toml.

• sdk/examples/app-template-http/src/lib.rs — canonical HTTP-API template (sync read-only)
• sdk/examples/app-template-http/src/client.rs
• sdk/examples/app-template-http/src/tool.rs
• sdk/examples/app-template-http/Cargo.toml — note edition = "2024" and crate-type = ["cdylib"]
• sdk/examples/hello-app/src/lib.rs — async tools (IS_ASYNC = true, run_async, DynAsyncSink), cancellation via sink.is_canceled(), panic containment
• docs/repo-structure.md — file roles and authoring guidelines
• docs/host-interop.md — public host tools (view_state, run_tx, stage_tx, simulate_batch, commit_tx, commit_eip712) and the ToolReturn/RouteStep envelope for multi-step flows
• docs/sdk-version-compatibility.md — exact-match SDK version gate enforced via aomi_sdk_version symbol
• 2 or 3 relevant apps under apps/*/src/{lib,client,tool}.rs. Recommended:
  • apps/binance — execution-oriented with auth, normalized models, namespaces = ["common"]
  • apps/oneinch — execution planner with multi-step preamble (quote → approval → swap)
  • apps/khalani or apps/polymarket — host handoff via ToolReturn::with_routes(...)

If the supplied docs mostly point to GitHub repositories, SDKs, or examples instead of listing public endpoints:

• treat those linked repositories as the real source of truth
• inspect their README, config examples, example commands, and RPC/API surfaces
• check whether they expose or produce a runnable service interface such as REST, GraphQL, JSON-RPC, gRPC, webhooks, or another stable client contract
• prefer building against that executable surface instead of wrapping the docs themselves
• avoid inventing a public transactional API that the docs do not actually publish

If the current repo is aomi-widget, also inspect:

• apps/landing/content/examples/*.mdx
• apps/landing/content/guides/build/**/*.mdx

If the aomi-apps checkout is not available, read:

• references/aomi-sdk-patterns.md — manifest shape, file roles, real-app conventions
• references/spec-to-tools.md — converting OpenAPI / SDK docs / endpoint lists into intent-shaped tools
• references/host-routes.md — ToolReturn envelope and RouteStep builders for execution apps that hand off to the host wallet
• references/examples.md — five end-to-end walkthroughs anchored to real apps (binance, builder fallback, polymarket routes upgrade, async tool with cancellation, SDK version bump)
• references/troubleshooting.md — common build/runtime failures with concrete fixes (untracked Cargo.toml, SDK version mismatch, async tool hangs, route resolution issues, JsonSchema derive failures)

Default Workflow

1. Identify the product surface:
   • What external API, SDK, repo, or spec is the source of truth?
   • What concrete callable surface exists: REST, GraphQL, JSON-RPC, gRPC, webhook, CLI contract, or something else?
   • Is there a real target we can point the app at: hosted service, self-hosted node, local example stack, or customer-provided endpoint?
   • Is this read-only, execution-oriented, or mixed?
   • What auth/env vars are required?
   • What user state must come from the host or caller?
   • Is this actually a public end-user API, a standard client interface exposed by a runtime/example app, or only builder-facing documentation?
2. Describe the intended user-facing toolset before implementation:
   • list the proposed tools by name
   • say what user intent each tool serves
   • call out which tools are read-only, which prepare actions, and which write or submit
   • mention any expected target URL, runtime, or host dependency
   • if the toolset is uncertain, surface the uncertainty before coding
   • identify the primary user workflow the app should make easy first
   • keep the first pass to the smallest sufficient toolset for that workflow unless the user asked for broader API coverage
3. Reduce the spec into semantically meaningful tools.
4. Scaffold or update the Aomi app using the standard file split:
   • lib.rs for manifest and preamble. Register with dyn_aomi_app! including the namespaces = [...] field — ["common"] for execution apps that depend on host tools (stage_tx, simulate_batch, commit_tx, commit_eip712), [] for read-only apps that don't.
   • client.rs for HTTP client, auth, models, and normalization
   • tool.rs for DynAomiTool implementations. Sync tools implement run; async tools set const IS_ASYNC: bool = true and implement run_async with DynAsyncSink::emit/complete/is_canceled (see sdk/examples/hello-app/src/lib.rs).
5. Write the preamble around actual tool behavior, confirmation rules, and any host handoff. Execution apps that drive multi-step wallet flows return ToolReturn::with_routes(...) instead of bare JSON — see references/host-routes.md.
6. Validate with the SDK build flow and add focused tests when logic is non-trivial.

Tool Design Rules

• First decide what kind of app this should be:
  • product client
  • execution assistant
  • builder / SDK / runtime assistant
• Before implementing, state the proposed toolset in concrete user-facing terms. This is part of the design, not optional polish.
• Prefer the smallest sufficient toolset that makes the primary user workflow work end to end.
• If there are multiple plausible integration targets, briefly state which one you are choosing and why before coding.
• Prefer tools that interact with an actual product surface over tools that merely restate documentation.
• A hosted API is not required. A self-hosted service, local example stack, standard RPC server, or other runnable interface still counts as a real integration target.
• If the source material is SDK- or architecture-heavy, first ask whether it produces a service that clients call. If yes, build the client for that service.
• Only fall back to a builder-oriented or docs-oriented tool surface when no stable executable target is available.
• Do not mirror every endpoint 1:1 unless that is actually the cleanest model-facing API or the user explicitly asked for broad coverage.
• Prefer 3 to 8 tools with clear user intent boundaries such as search_*, get_*, build_*, submit_*, list_*, or resolve_*.
• Prefer intent-shaped tool names over raw protocol or transport names when practical.
• Aggregate noisy upstream endpoints behind a smaller tool surface when the model does not need the raw distinction.
• Prefer typed arguments over raw JSON string blobs when the primary workflow can be modeled cleanly that way.
• Separate core tools from escape hatches. A generic fallback tool such as *_rpc or *_raw is fine, but it should not replace a clean core workflow.
• Keep args typed and documented with JsonSchema. Field doc comments are model-facing and matter.
• Return stable JSON with predictable keys. Normalize upstream naming, paging, and inconsistent shapes inside client.rs or helper functions.
• Convert upstream errors into short actionable messages. Do not leak raw HTML, secrets, or giant payload dumps.

File Responsibilities

lib.rs

• Keep it easy to scan.
• Define PREAMBLE or a small build_preamble() hook.
• Register tools with dyn_aomi_app!. Always include the namespaces field explicitly — namespaces = ["common"] for execution apps, namespaces = [] for read-only apps. The macro generates the C ABI exports (aomi_create, aomi_manifest, aomi_async_tool_start, etc.) and embeds the SDK version stamp the host uses for the exact-match compatibility check.
• Only keep manifest-level wiring here.

client.rs

• Own the app struct, HTTP client, auth headers, env vars, typed models, and response normalization.
• Prefer reqwest::blocking::Client with explicit timeouts for sync tools, matching the current SDK examples.
• Keep third-party API quirks here instead of spreading them across tool implementations.

tool.rs

• Implement DynAomiTool. Required associated types: App (the app struct from client.rs) and Args (a JsonSchema + Deserialize struct). Required consts: NAME, DESCRIPTION. Optional const: IS_ASYNC (defaults to false).
• Use descriptions that tell the model when to call the tool, not just what endpoint it wraps.
• Map normalized client results into concise JSON results. Sync tools return Result<Value, String> from run(); async tools return Result<(), String> from run_async() and emit progress through the DynAsyncSink. Cancellation: poll sink.is_canceled() and return Ok(()) early.
• Use DynToolCallCtx when host state such as connected wallet, session state, or caller attributes is needed. ctx.session_id and ctx.call_id are stable identifiers for logging or routing.
• For execution apps that hand off to the wallet, return ToolReturn::with_routes(value, [RouteStep::on_return(...).bind_as(...).prompt(...)]) instead of a bare Value. The run_with_routes() method on DynAomiTool has a default impl that wraps run() — only override it when you need routes. See references/host-routes.md.

Preamble Rules

Write the preamble from the app's real contract:

• Define role, capabilities, workflow, and guardrails.
• Mention tool order for multi-step flows.
• State explicit confirmation requirements before write actions.
• If dates matter, include the current date or instruct the app to use exact dates.
• If the app relies on host wallet/signing tools, say that clearly and do not imply hidden infrastructure.

For deeper patterns and examples, read references/aomi-sdk-patterns.md.

Host Interop And Execution

For execution-oriented apps:

• Follow the public host conventions from docs/host-interop.md. The available host tools are view_state (read-only eth_call), run_tx (state-changing simulation), stage_tx (queue for later signing), simulate_batch (dry-run staged txs by pending_tx_id), commit_tx (sign and broadcast one staged tx), and commit_eip712 (sign typed data). Apps reference these by name in tool descriptions and route hints — they are public contract, not private infrastructure.
• Do not invent private namespaces (CommonNamespace etc.) or internal fallback behavior.
• When the next step belongs to the host wallet or signer, return a ToolReturn envelope with explicit RouteStep builders instead of any prose-based SYSTEM_NEXT_ACTION convention. The runtime's RoutedEventBridge resolves OnSyncReturn and OnBoundEvent triggers, splices wallet-callback artifacts (signature, transaction_hash) into hinted args, and injects the continuation prompt. The runtime never parses prose — structured fields are the contract.
• Preserve exact transaction or signature args when a downstream host tool must execute them. For raw external tx payloads, use stage_tx with data: { raw: "0x..." }; for ABI-driven calls, use data: { encode: { signature, args } }.
• Do not claim a write succeeded until the upstream API submit step has actually completed.

For deeper coverage of the routes pattern, including OnSyncReturn vs OnBoundEvent, bind_as aliases, and worked examples from apps/khalani and apps/polymarket, read references/host-routes.md.

Validation

When working inside aomi-apps:

• Scaffold with cargo run -p xtask -- new-app <name> if starting from scratch, or copy sdk/examples/app-template-http. The xtask auto-derives StructName from the app name, generates lib.rs/client.rs/tool.rs, and registers the app in the workspace exclude = [...] list. For a one-shot wrapper that also handles git add for discovery and runs an initial compile check, use templates/quick-scaffold.sh — pass the app name and optionally --build to also run xtask build-aomi.
• Build the plugin with cargo run -p xtask -- build-aomi --app <name>. Optional flags: --release, --target <triple>. The build validates the manifest, codesigns on macOS, and validates the produced plugin.
• If build-aomi reports zero built plugins for a brand new app, check whether the new apps/<name>/Cargo.toml is still untracked. The xtask prefers git ls-files apps/*/Cargo.toml for discovery and falls back to a directory scan only when nothing is tracked. Apps marked with [package.metadata.aomi.skip] are skipped intentionally.
• For a direct compile signal on an untracked app, use cargo build --manifest-path apps/<name>/Cargo.toml.
• If the app has meaningful branching or normalization logic, add unit tests with aomi_sdk::testing::{TestCtxBuilder, run_tool, run_async_tool}. TestCtxBuilder::new(tool_name).build() produces a DynToolCallCtx; run_tool returns a full ToolReturn with routes; run_async_tool returns (updates, terminal).
• The host-plugin compatibility gate is exact-match SDK version. After bumping sdk/Cargo.toml package.version, all apps must be rebuilt — the host rejects plugins whose aomi_sdk_version symbol does not match its compiled AOMI_SDK_VERSION. See docs/sdk-version-compatibility.md.
• If a real target is available, validate the app with a short ladder:
  • compile/build
  • connectivity check
  • one representative read flow
  • one representative write or submit flow when applicable
  • post-write verification such as status, receipt, or refreshed state
• Prefer proving one end-to-end user scenario over checking many disconnected endpoints.

When the task also touches docs or demos in aomi-widget, update the relevant examples or guides to match the new app behavior.

Output Expectations

Aim to leave behind:

• a coherent Aomi app crate or patch
• typed tool args and strong descriptions
• a preamble that explains the tool contract and rules
• stable JSON outputs for the host/model
• an app that can point at a real product surface when one exists
• a short validation pass or a clear note about what could not be verified