diff --git a/content/docs.yml b/content/docs.yml index 57c5ace1d..22bde910e 100644 --- a/content/docs.yml +++ b/content/docs.yml @@ -83,16 +83,22 @@ navigation: slug: pricing-resources - section: Build with AI contents: - - page: AI-powered IDEs - path: tutorials/build-with-ai/ai-prompting.mdx - - page: Add Alchemy RPC To Any Project - path: tutorials/build-with-ai/add-alchemy-rpc-to-any-project.mdx - - page: Build a Web3 Dashboard - path: tutorials/build-with-ai/web3-dashboard-prompt.mdx - - page: Learning Alchemy's Data APIs using Cursor - path: tutorials/build-with-ai/data-apis-with-cursor.mdx + - page: Overview + path: tutorials/build-with-ai/overview.mdx + - page: Agent Skills + path: tutorials/build-with-ai/alchemy-agent-skills.mdx + - page: Agent Authentication and Payment + path: tutorials/build-with-ai/alchemy-for-agents.mdx - page: Alchemy MCP Server path: tutorials/build-with-ai/alchemy-mcp-server.mdx + - section: Tutorials + contents: + - page: Add Alchemy RPC To Any Project + path: tutorials/build-with-ai/add-alchemy-rpc-to-any-project.mdx + - page: Build a Web3 Dashboard + path: tutorials/build-with-ai/web3-dashboard-prompt.mdx + - page: Learning Alchemy's Data APIs using Cursor + path: tutorials/build-with-ai/data-apis-with-cursor.mdx - section: Tools contents: - page: Tools Quickstart diff --git a/content/tutorials/build-with-ai/alchemy-agent-skills.mdx b/content/tutorials/build-with-ai/alchemy-agent-skills.mdx new file mode 100644 index 000000000..97f1ce588 --- /dev/null +++ b/content/tutorials/build-with-ai/alchemy-agent-skills.mdx @@ -0,0 +1,82 @@ +--- +title: Alchemy Agent Skills +description: Give your AI coding agent full knowledge of every Alchemy API with a single command. Once installed, your agent knows every endpoint, authentication method, pagination pattern, and error handling strategy without any manual prompting. +subtitle: Give your AI coding agent full knowledge of every Alchemy API with a single command. Once installed, your agent knows every endpoint, authentication method, pagination pattern, and error handling strategy without any manual prompting. +slug: docs/alchemy-agent-skills +--- + +Skills work with [Claude Code](https://www.anthropic.com/claude-code), [Codex](https://openai.com/index/codex/), [Cursor](https://cursor.com), [VS Code Copilot](https://code.visualstudio.com/docs/copilot/overview), and any AI tool that supports the [Agent Skills specification](https://agentskills.io). + +## Install the skills + +```bash +npx skills add alchemyplatform/skills --yes +``` + +This installs two skills: + +| Skill | Auth method | Best for | +|---|---|---| +| `alchemy-api` | API key | You have an [Alchemy API key](https://dashboard.alchemy.com/) and you're building a server or dApp | +| `agentic-gateway` | Wallet + x402 | Your agent needs to access Alchemy without an API key | + +After installation, your agent will ask which path you want before making any API requests. + +## What's included + +Both skills cover the full Alchemy API surface: + +* **Node RPC:** EVM JSON-RPC methods (`eth_*`) and Alchemy-enhanced methods across Ethereum, Base, Arbitrum, BNB, and more +* **Token API:** `alchemy_getTokenBalances`, `alchemy_getTokenMetadata`, allowances +* **NFT API:** Ownership lookups, metadata, contract data, spam filtering +* **Transfers API:** `alchemy_getAssetTransfers` with filtering and pagination +* **Prices API:** Spot prices by symbol/address, historical price data +* **Portfolio API:** Multi-chain token balances and NFT data +* **Simulation API:** `alchemy_simulateAssetChanges` for transaction previews +* **Webhooks:** Address activity monitoring, webhook creation and signature verification +* **Solana:** RPC, DAS API (`getAssetsByOwner`), and gRPC streams + +Each skill includes endpoint URLs, authentication patterns, code examples, pagination limits, error handling guidance, and network naming conventions. + +## Use the `alchemy-api` skill + +The `alchemy-api` skill is for developers who have an [Alchemy API key](https://dashboard.alchemy.com/). Set `ALCHEMY_API_KEY` as an environment variable, and your agent handles the rest: it knows every endpoint URL, authentication pattern, and request format across all Alchemy APIs. + +If you don't have an API key, create one for free at the [Alchemy Dashboard](https://dashboard.alchemy.com/). + +## Use the `agentic-gateway` skill + +The `agentic-gateway` skill activates when `$ALCHEMY_API_KEY` isn't set. It teaches your agent how to access Alchemy APIs autonomously using a crypto wallet and the [x402 payment protocol](https://www.x402.org/). + +Your agent will walk you through wallet setup and handle the rest: + +* **Create or import a wallet:** your agent can set up an EVM wallet (pays USDC on Base) or a Solana wallet (pays USDC on Solana) +* **Authenticate:** your agent generates a signed token using [SIWE](https://eips.ethereum.org/EIPS/eip-4361) (EVM) or SIWS (Solana) and includes it in API requests +* **Purchase credits:** your agent buys 1 USDC worth of credits from your wallet. When credits run out, your agent purchases another 1 USDC of credits automatically + +Your wallet type only determines authentication and payment. Either wallet type can query any chain across [all networks Alchemy supports](docs/reference/node-supported-chains). + +For a full walkthrough of the authentication and payment flow, see [Agent Authentication and Payment](docs/alchemy-for-agents). + +## How skills work + +Agent Skills follow an open specification. A skill is a Markdown file (`SKILL.md`) that contains structured knowledge (API docs, code examples, decision trees, and rules) that an AI agent reads and follows. + +When you run `npx skills add`, the skill files are added to your project. Your AI agent reads these files and uses them as context when writing code or making API requests. + +Skills are different from MCP servers: + +| | Agent Skills | MCP Server | +|---|---|---| +| **What it does** | Teaches the agent *how* to use APIs | Gives the agent *tools* to call APIs directly | +| **When it's used** | When the agent writes code that uses Alchemy APIs | When the agent needs to query live blockchain data | +| **Output** | The agent writes code using Alchemy APIs | The agent gets blockchain data back in the conversation | + +You can use both together: Skills for API knowledge and MCP for live data queries. + +## Next steps + +* [GitHub: alchemyplatform/skills](https://github.com/alchemyplatform/skills) +* [Alchemy Dashboard](https://dashboard.alchemy.com/) +* [Agent Authentication and Payment](docs/alchemy-for-agents) +* [Alchemy MCP Server](docs/alchemy-mcp-server) diff --git a/content/tutorials/build-with-ai/alchemy-for-agents.mdx b/content/tutorials/build-with-ai/alchemy-for-agents.mdx new file mode 100644 index 000000000..8618a8e3e --- /dev/null +++ b/content/tutorials/build-with-ai/alchemy-for-agents.mdx @@ -0,0 +1,70 @@ +--- +title: Agent Authentication and Payment +description: Authenticate your AI agent with an EVM or Solana wallet instead of an API key using SIWE and SIWS. Your agent purchases credits with USDC via the x402 payment protocol. +subtitle: Authenticate your AI agent with an EVM or Solana wallet instead of an API key using SIWE and SIWS. Your agent purchases credits with USDC via the x402 payment protocol. +slug: docs/alchemy-for-agents +--- + +## How it works + +x402 wallet authentication uses three open standards: + +* **[SIWE (Sign-In With Ethereum)](https://eips.ethereum.org/EIPS/eip-4361):** Your agent authenticates by signing a message with an EVM wallet. +* **[SIWS (Sign-In With Solana)](https://phantom.com/learn/developers/sign-in-with-solana):** Adapted from EIP-4361 for Solana's ed25519 signatures. Your agent authenticates with a Solana wallet. +* **[x402](https://www.x402.org/):** An open protocol for HTTP-native payments. When your agent's credits run out, the server responds with HTTP 402, your agent purchases more credits and retries the request. Zero protocol fees. + +## The flow + +When your agent needs to access Alchemy APIs without an API key, it handles the full wallet authentication flow: + +1. **Wallet setup:** Your agent creates a new wallet or imports an existing one. You choose between an EVM wallet (USDC on Base) or a Solana wallet (USDC on Solana). +2. **Authentication:** Your agent generates a signed auth token using SIWE (EVM) or SIWS (Solana) and includes it in every API request. +3. **Credits:** Your agent purchases 1 USDC worth of credits from your wallet. When credits run out, the server responds with HTTP 402, and your agent purchases another 1 USDC of credits automatically. + +Your wallet type only determines authentication and payment. Either wallet type can query any chain across [all networks Alchemy supports](docs/reference/node-supported-chains). + +## What your agent can access + +All standard Alchemy APIs are available through the x402 gateway: + +* **Node RPC:** Standard Ethereum JSON-RPC methods (`eth_*`) plus Alchemy-enhanced methods, across 100+ chains +* **Token API:** Token balances, metadata, and allowances +* **NFT API:** NFT ownership, metadata, sales, and spam detection +* **Transfers API:** Asset transfer history with filtering +* **Prices API:** Spot and historical token prices +* **Portfolio API:** Multi-chain balances and portfolio data +* **Simulation API:** Transaction simulation and outcome prediction + +These are the same APIs available with a standard API key. The only difference is the authentication and payment mechanism. + +## EVM vs Solana wallets + +| | EVM wallet | Solana wallet | +|---|---|---| +| **Standard** | SIWE (EIP-4361) | SIWS | +| **Signature** | secp256k1 | ed25519 | +| **Payment** | USDC on Base | USDC on Solana | +| **Queryable chains** | [All supported networks](docs/reference/node-supported-chains) | [All supported networks](docs/reference/node-supported-chains) | + +## Install as an agent skill + +Install the `agentic-gateway` [agent skill](docs/alchemy-agent-skills) so your AI coding agent learns this flow automatically: + +```bash +npx skills add alchemyplatform/skills --yes +``` + +Your agent will walk you through wallet setup and handle authentication and payments from there. + +## Watch it in action + +
+ +* [GitHub: alchemyplatform/alchemy-mcp-server](https://github.com/alchemyplatform/alchemy-mcp-server) +* [npm: @alchemy/mcp-server](https://www.npmjs.com/package/@alchemy/mcp-server) diff --git a/content/tutorials/build-with-ai/overview.mdx b/content/tutorials/build-with-ai/overview.mdx new file mode 100644 index 000000000..e25b30b9a --- /dev/null +++ b/content/tutorials/build-with-ai/overview.mdx @@ -0,0 +1,62 @@ +--- +title: Build with AI +description: Give your AI agent knowledge of Alchemy APIs with agent skills, query live onchain data through MCP, and authenticate autonomously with agent authentication and payment. +subtitle: Give your AI agent knowledge of Alchemy APIs with agent skills, query live onchain data through MCP, and authenticate autonomously with agent authentication and payment. +slug: docs/build-with-ai-overview +--- + +## Pick the right tool + +### Agent Skills + +[Alchemy Agent Skills](https://github.com/alchemyplatform/skills) are plug-and-play knowledge packages for AI coding agents. Install them with a single command, and your agent knows how to use every Alchemy API including endpoints, authentication, pagination, error handling, and more. + +```bash +npx skills add alchemyplatform/skills --yes +``` + +* Two skills included: `alchemy-api` (API key auth) and `agentic-gateway` (wallet-based x402 auth when no API key is set) +* Works with [Claude Code](https://www.anthropic.com/claude-code), [Codex](https://openai.com/index/codex/), [Cursor](https://cursor.com), [VS Code Copilot](https://code.visualstudio.com/docs/copilot/overview), and other agents that support the [skills spec](https://agentskills.io) + +[Get started with Agent Skills →](docs/alchemy-agent-skills) + +### MCP Server + +The [Alchemy MCP Server](https://github.com/alchemyplatform/alchemy-mcp-server) exposes our APIs through the [Model Context Protocol](https://modelcontextprotocol.io/), giving AI tools direct access to blockchain data as tool calls. + +* 11+ blockchain tools including token prices, NFT data, transaction history, balances, and more +* 50+ supported chains +* Works with Claude Desktop, Claude Code, Cursor, VS Code Copilot, and Windsurf + +[Get started with the MCP Server →](docs/alchemy-mcp-server) + +### Agent authentication and payment + +Your agent can authenticate with a crypto wallet instead of an API key, purchasing credits with USDC via the [x402 payment protocol](https://www.x402.org/). This is what the `agentic-gateway` skill teaches your agent automatically. + +* No API key required: supports authentication via [SIWE (Sign-In With Ethereum)](https://eips.ethereum.org/EIPS/eip-4361) and SIWS (Sign-In With Solana) +* Supports payment via USDC on Base and Solana +* Wallet type is independent of which chain you query + +[Learn about agent authentication and payment →](docs/alchemy-for-agents) + +## Compare tools by use case + +| I want to... | Use | +|---|---| +| Give my AI coding agent knowledge of all Alchemy APIs | [Agent Skills](docs/alchemy-agent-skills) | +| Let my IDE copilot query live onchain data during a conversation | [MCP Server](docs/alchemy-mcp-server) or [Agent Skills](docs/alchemy-agent-skills) | +| Build an autonomous agent that authenticates with a wallet and purchases credits with USDC | [Agent Skills](docs/alchemy-agent-skills) + [Agent Authentication and Payment](docs/alchemy-for-agents) | +| Give my coding agent API knowledge *and* live data access | Agent Skills + MCP Server | + +These tools are complementary. For example, an agent using **Skills** to understand our API surface can also connect to the **MCP Server** to query live data, or use the **`agentic-gateway` skill** to operate autonomously without a pre-provisioned API key. + +## Supported AI tools + +| Tool | Skills | MCP Server | Agent Auth | +|---|---|---|---| +| [Claude Code](https://www.anthropic.com/claude-code) | Yes | Yes | Yes | +| [Cursor](https://cursor.com) | Yes | Yes | Yes | +| [Codex](https://openai.com/index/codex/) | Yes | Yes | Yes | +| [VS Code Copilot](https://code.visualstudio.com/docs/copilot/overview) | Yes | Yes | — | +| [Claude Desktop](https://claude.ai/download) | Yes | Yes | — |