diff --git a/developers/ai-agents.mdx b/developers/ai-agents.mdx new file mode 100644 index 0000000..b1decc1 --- /dev/null +++ b/developers/ai-agents.mdx @@ -0,0 +1,9 @@ +--- +title: AI Agents +description: Use Boundless with AI coding agents like Claude, Cursor, Copilot, and other LLM-powered tools. +icon: robot +--- + +import AiAgentsContent from "/snippets/ai-agents.mdx"; + + diff --git a/developers/quick-start.mdx b/developers/quick-start.mdx index b548a35..24a863e 100644 --- a/developers/quick-start.mdx +++ b/developers/quick-start.mdx @@ -8,6 +8,20 @@ import { PriorityRequestorForm } from "/snippets/priority-requestor-form.jsx" +## Getting started with an AI agent + +Paste this prompt into your AI coding agent (Claude Code, Cursor, Copilot, etc.) to get started: + +```text +Clone https://github.com/boundless-xyz/boundless, read the skill file at +.claude/skills/requesting/SKILL.md, and walk me through submitting my first +proof request on Boundless. +``` + +The monorepo includes a [`requesting`](https://github.com/boundless-xyz/boundless/tree/main/.claude/skills/requesting) skill with step-by-step guidance for wallet setup, CLI install, deposit, submit, and proof retrieval. See [AI Agents](/developers/ai-agents) for more. + +--- + The [Boundless Foundry Template](https://github.com/boundless-xyz/boundless-foundry-template) is the best way to get started. It provides a starter application which has the following components: * A zkVM guest program, [`is-even`](https://github.com/boundless-xyz/boundless-foundry-template/blob/main/guests/is-even/src/main.rs) diff --git a/docs.json b/docs.json index 4a23b7b..7655707 100644 --- a/docs.json +++ b/docs.json @@ -108,7 +108,8 @@ { "group": " ", "pages": [ - "developers/quick-start" + "developers/quick-start", + "developers/ai-agents" ] }, { @@ -189,7 +190,8 @@ { "group": " ", "pages": [ - "provers/quick-start" + "provers/quick-start", + "provers/ai-agents" ] }, { diff --git a/navigation.yaml b/navigation.yaml index 83b47a5..1040f7c 100644 --- a/navigation.yaml +++ b/navigation.yaml @@ -16,6 +16,7 @@ tabs: - group: " " pages: - developers/quick-start + - developers/ai-agents - group: Introduction icon: book-open @@ -78,6 +79,7 @@ tabs: - group: " " pages: - provers/quick-start + - provers/ai-agents - group: Core Concepts icon: gear diff --git a/provers/ai-agents.mdx b/provers/ai-agents.mdx new file mode 100644 index 0000000..b1decc1 --- /dev/null +++ b/provers/ai-agents.mdx @@ -0,0 +1,9 @@ +--- +title: AI Agents +description: Use Boundless with AI coding agents like Claude, Cursor, Copilot, and other LLM-powered tools. +icon: robot +--- + +import AiAgentsContent from "/snippets/ai-agents.mdx"; + + diff --git a/provers/quick-start.mdx b/provers/quick-start.mdx index aa72a89..02c9c6a 100644 --- a/provers/quick-start.mdx +++ b/provers/quick-start.mdx @@ -4,6 +4,20 @@ description: Run a prover on Boundless. icon: fast-forward --- +## Getting started with an AI agent + +Paste this prompt into your AI coding agent (Claude Code, Cursor, Copilot, etc.) to get started: + +```text +Clone https://github.com/boundless-xyz/boundless, read the skill file at +.claude/skills/setup-prover/SKILL.md, and walk me through deploying a Boundless +prover to my GPU server. +``` + +The monorepo includes a [`setup-prover`](https://github.com/boundless-xyz/boundless/tree/main/.claude/skills/setup-prover) skill with step-by-step guidance for Ansible-based deployment, config tuning, and troubleshooting. See [AI Agents](/provers/ai-agents) for more. + +--- + ## Requirements A recommended minimum configuration for proving performance: diff --git a/snippets/ai-agents.mdx b/snippets/ai-agents.mdx new file mode 100644 index 0000000..2d45d25 --- /dev/null +++ b/snippets/ai-agents.mdx @@ -0,0 +1,63 @@ +AI coding agents can use Boundless more effectively when they have access to structured skill files that describe the product's capabilities, workflows, and common patterns. + +Boundless publishes a [skill.md](https://docs.boundless.network/skill.md) file following the [agentskills.io](https://agentskills.io) specification. This file gives agents structured context about: + +- **Requestor workflows** — submitting proof requests, configuring offers, tracking fulfillment +- **Prover workflows** — setting up nodes, configuring Bento and Broker, depositing collateral +- **SDK and CLI usage** — common commands, environment variables, storage providers +- **Decision guidance** — when to use Groth16 vs aggregated proofs, onchain vs offchain submission +- **Common gotchas** — free RPC failures, journal size limits, collateral requirements + +## Add Boundless to your agent + +Install the Boundless skill into your AI agent's context using the [skills CLI](https://www.npmjs.com/package/skills): + +```bash +npx skills add https://docs.boundless.network +``` + +This fetches the `skill.md` from Boundless and adds it to your agent's context, so it can help you build on Boundless with accurate, up-to-date guidance. + +## Monorepo skills + +The [Boundless monorepo](https://github.com/boundless-xyz/boundless) also includes task-specific skills in [`.claude/skills/`](https://github.com/boundless-xyz/boundless/tree/main/.claude/skills) that provide deeper, step-by-step guidance for common workflows: + +| Skill | Description | +|-------|-------------| +| [`requesting`](https://github.com/boundless-xyz/boundless/tree/main/.claude/skills/requesting) | Submit a proof request end-to-end — wallet setup, CLI install, deposit, submit, poll, and proof retrieval. | +| [`setup-prover`](https://github.com/boundless-xyz/boundless/tree/main/.claude/skills/setup-prover) | Deploy and manage a Boundless prover on a GPU server using Ansible. | +| [`boundless-cli`](https://github.com/boundless-xyz/boundless/tree/main/.claude/skills/boundless-cli) | Complete reference for the Boundless CLI — requestor, prover, and rewards commands. | + +These skills are automatically available to agents working inside the Boundless monorepo (e.g., Claude Code, Cursor). When you clone the repo, your agent can read the skill files directly. + + +If you're using [Claude Code](https://docs.anthropic.com/en/docs/claude-code), the skills in `.claude/skills/` are loaded automatically when relevant. Just ask Claude to help you set up a prover or submit a proof request. + + +## What agents can help with + +Here are some example prompts to try with your AI agent after adding the Boundless skill: + +**For requestors:** +``` +Help me submit my first proof request on Boundless using the CLI +``` +``` +I have a RISC Zero guest program — walk me through requesting a proof on Boundless +``` + +**For provers:** +``` +Help me set up a Boundless prover on my GPU server +``` +``` +My broker isn't picking up requests — help me troubleshoot +``` + +**For developers:** +``` +How do I use Steel to read EVM state in my guest program? +``` +``` +What's the difference between Groth16 and aggregated proofs? +```