@peridot-agent/agent-kit 0.2.0 → 0.2.1

package/README.md

@@ -6,6 +6,66 @@ The Peridot Agent Kit is a TypeScript SDK that wraps Peridot's lending protocol
 
 ---
 
+## Get started in 3 steps
+
+### Step 1 — Install
+
+```bash
+npm install @peridot-agent/agent-kit
+```
+
+### Step 2 — Pick your setup
+
+**Use with Claude Desktop or Cursor (no code needed)**
+
+Add this to `~/.claude/claude_desktop_config.json` (or your Cursor MCP config):
+
+```json
+{
+  "mcpServers": {
+    "peridot": {
+      "command": "npx",
+      "args": ["-y", "-p", "@peridot-agent/agent-kit", "peridot-mcp"],
+      "env": {
+        "BICONOMY_API_KEY": "your-key-here"
+      }
+    }
+  }
+}
+```
+
+`BICONOMY_API_KEY` is optional — omit it if you only use BSC, Monad, or Somnia. It's only needed for cross-chain tools (Arbitrum, Base, Ethereum, Polygon, Optimism, Avalanche).
+
+Restart Claude Desktop. Ask it *"What can I lend on Peridot?"* — it just works.
+
+**Use in your own agent (LangChain)**
+
+```typescript
+import { createLangChainTools } from "@peridot-agent/agent-kit/langchain"
+
+const tools = createLangChainTools({
+  biconomyApiKey: process.env.BICONOMY_API_KEY,
+})
+// pass tools to your agent as usual
+```
+
+**Use in your own agent (Vercel AI SDK)**
+
+```typescript
+import { createVercelAITools } from "@peridot-agent/agent-kit/vercel-ai"
+
+const tools = createVercelAITools({
+  biconomyApiKey: process.env.BICONOMY_API_KEY,
+})
+// pass tools to generateText / streamText
+```
+
+### Step 3 — Get a Biconomy API key
+
+Cross-chain tools (Arbitrum, Base, Ethereum, Polygon, Optimism, Avalanche) require a [Biconomy MEE API key](https://dashboard.biconomy.io). Same-chain tools on BSC, Monad, and Somnia work without one.
+
+---
+
 ## Table of Contents
 
 1. [Why this exists](#-why-this-exists)
@@ -77,7 +137,7 @@ The MCP server exposes all Peridot tools over [Model Context Protocol](https://m
 
 | Variable | Required | Description |
 |---|---|---|
-| `BICONOMY_API_KEY` | Yes (cross-chain tools) | Biconomy MEE API key |
+| `BICONOMY_API_KEY` | No* | Biconomy MEE API key. Required only for cross-chain tools (Arbitrum, Base, Ethereum, Polygon, Optimism, Avalanche). BSC, Monad, and Somnia work without it. |
 | `PERIDOT_API_URL` | No | Override platform API (default: `https://app.peridot.finance`) |
 | `PERIDOT_NETWORK` | No | `mainnet` (default) or `testnet` |
 | `PERIDOT_RPC_BSC` | No | Custom BSC RPC URL |