Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mintlify-docs/ai-tools/build-local-rgb-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ RGB assets live on Bitcoin UTXOs, so the node needs a little signet BTC before i
KALEIDO_NETWORK=signet RLN_NODE_URL=http://localhost:3001 npx -y kaleido-mcp
```

The server logs `network: signet` and waits on stdio. You do not need to keep it running by hand: the agent in the next step starts it as a child process. `WDK_SEED` is optional here; without it the Spark tools stay off and the RGB, DEX, payment and market tools still work. See [MCP Servers](/ai-tools/mcp-servers#network-preset) for every variable.
The server logs `network: signet` and waits on stdio. You do not need to keep it running by hand: the agent in the next step starts it as a child process. `WDK_SEED` is optional here, and plain `npx` does not install the Spark wallet package; without them the Spark tools stay off and the RGB, DEX, payment and market tools still work. See [MCP Servers](/ai-tools/mcp-servers#network-preset) for every variable.

<Tip>
Want to try the tools before writing any code? Add the same command to Claude Desktop or Claude Code with the config in [Client Configuration](/ai-tools/mcp-servers#client-configuration), then ask for your RGB balance. The rest of this tutorial swaps that hosted model for a local one.
Expand Down
4 changes: 2 additions & 2 deletions mintlify-docs/ai-tools/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Four surfaces expose the same Bitcoin tools to a model, and they differ mostly i
| Requirement | Details |
|-------------|---------|
| **A test network** | Signet. The KaleidoSwap API runs a signet instance at `https://api.signet.kaleidoswap.com`, and the [RGB faucet](https://faucet.mutinynet.kaleidoswap.com) sends test assets. Never a first run on mainnet |
| **A wallet seed** | A throwaway BIP-39 mnemonic for the test network, set as `WDK_SEED` |
| **A node** | Only for the `wdk_*` tools and atomic swaps. [KaleidoCLI](/cli/installation) starts a signet RGB Lightning Node with one command. Spark tools need just a seed, market data needs nothing |
| **A wallet seed** | Only for the Spark tools: a throwaway BIP-39 mnemonic for the test network, set as `WDK_SEED`, plus the optional Spark wallet package (see [MCP Servers](/ai-tools/mcp-servers)) |
| **A node** | Only for the `wdk_*` tools and atomic swaps. [KaleidoCLI](/cli/installation) starts a signet RGB Lightning Node with one command. Spark tools need a seed and the Spark wallet package, market data needs nothing |
| **An MCP host or LLM key** | Claude Desktop or another MCP client, or an Anthropic/OpenAI key for KaleidoAgent |

If you have not installed anything yet, start with [Installation](/ai-tools/installation). For an end-to-end path from an empty machine to a local model moving RGB assets on signet, follow [Build a Local RGB Agent](/ai-tools/build-local-rgb-agent).
Expand Down
2 changes: 2 additions & 0 deletions mintlify-docs/ai-tools/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ KALEIDO_NETWORK=signet npx -y kaleido-mcp
resolves an older cached version, run `npx -y kaleido-mcp@latest` once.
</Note>

From 0.3.1 the Spark and Liquid wallets are optional and not installed by plain `npx`. To enable them, run `npx -y -p kaleido-mcp -p @tetherto/wdk-wallet-spark -p @kaleidorg/wdk-wallet-liquid kaleido-mcp` and set `WDK_SEED` / `LIQUID_MNEMONIC`.

For the RGB tools you also need an RGB Lightning Node. [KaleidoCLI](/cli/installation) runs one on signet in Docker, see [Build a Local RGB Agent](/ai-tools/build-local-rgb-agent) for the full path.

Three per-wallet servers, `wdk-wallet-mcp`, `wdk-wallet-spark-mcp`, and `wdk-wallet-liquid-mcp`, remain standalone rather than folded into the gateway and build from source:
Expand Down
29 changes: 20 additions & 9 deletions mintlify-docs/ai-tools/mcp-servers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ KALEIDO_NETWORK=signet npx -y kaleido-mcp
`npx -y kaleido-mcp@latest` once, or build from source.
</Note>

<Note>
From 0.3.1 the Spark and Liquid wallets are optional peer dependencies that plain
`npx -y kaleido-mcp` does not install. With `WDK_SEED` or `LIQUID_MNEMONIC` set but
the package missing, the server still starts and logs an install hint. To enable them:

```bash
npx -y -p kaleido-mcp -p @tetherto/wdk-wallet-spark -p @kaleidorg/wdk-wallet-liquid kaleido-mcp
```
</Note>

In practice an MCP host runs this for you, point its config at the command (see [Client Configuration](#client-configuration) below). For development, or to run a specific commit, build from source instead:

```bash
Expand All @@ -86,24 +96,25 @@ PORT=3010 KALEIDO_NETWORK=signet WDK_SEED="word1 word2 ..." node dist/index.js

### Network Preset

`KALEIDO_NETWORK` picks a set of defaults in one variable. It accepts `mainnet` (the default) or `signet`:
`KALEIDO_NETWORK` picks a set of defaults in one variable. It accepts `signet` (the default from 0.3.1) or `mainnet`:

| Preset | KaleidoSwap API | Spark network |
|--------|-----------------|---------------|
| `mainnet` | `https://api.kaleidoswap.com` | `MAINNET` |
| `signet` | `https://api.signet.kaleidoswap.com` | Spark's test network (`REGTEST` in the Spark SDK) |
| `mainnet` | None: set `KALEIDOSWAP_API_URL` to your own maker endpoint | `MAINNET` |

The preset only fills in defaults. Any variable you set explicitly, such as `KALEIDOSWAP_API_URL` or `SPARK_NETWORK`, wins over it. An unknown value stops the server at startup rather than silently falling back to mainnet. `RLN_NODE_URL` is not part of the preset: point it at your own node, which on signet is usually the one [KaleidoCLI](/cli/installation) runs on `http://localhost:3001`.
The preset only fills in defaults. Any variable you set explicitly, such as `KALEIDOSWAP_API_URL` or `SPARK_NETWORK`, wins over it. There is no public mainnet KaleidoSwap API, so `mainnet` without `KALEIDOSWAP_API_URL` stops the server at startup, as does an unknown value. `RLN_NODE_URL` is not part of the preset: point it at your own node, which on signet is usually the one [KaleidoCLI](/cli/installation) runs on `http://localhost:3001`.

| Env var | Required | Description |
|---------|----------|--------------|
| `KALEIDO_NETWORK` | No | `mainnet` (default) or `signet`. Sets the defaults in [Network Preset](#network-preset) |
| `WDK_SEED` | Yes, for Spark tools | BIP-39 mnemonic for the Spark wallet. The server still boots without it, the Spark tools are just disabled |
| `KALEIDO_NETWORK` | No | `signet` (default) or `mainnet`. Sets the defaults in [Network Preset](#network-preset) |
| `WDK_SEED` | Yes, for Spark tools | BIP-39 mnemonic for the Spark wallet. Also needs the optional `@tetherto/wdk-wallet-spark` package. The server still boots without either, the Spark tools are just disabled |
| `LIQUID_MNEMONIC` | Yes, for Liquid tools | BIP-39 mnemonic for the Liquid wallet. Also needs the optional `@kaleidorg/wdk-wallet-liquid` package |
| `SPARK_NETWORK` | No | Overrides the preset's Spark network: `MAINNET`, or `REGTEST` for Spark's test network |
| `SPARK_SCAN_API_KEY` | No | SparkScan API key |
| `SPARK_USDT_TOKEN` | No | Default Spark token identifier |
| `RLN_NODE_URL` | No | RLN daemon URL, default `http://localhost:3001` |
| `KALEIDOSWAP_API_URL` | No | Overrides the preset's KaleidoSwap API URL. `KALEIDO_API_URL` is accepted as well |
| `KALEIDOSWAP_API_URL` | With `mainnet` | KaleidoSwap maker API URL, overriding the preset. Required on `mainnet`, which has no public endpoint. `KALEIDO_API_URL` is accepted as well |
| `KALEIDO_BIN` | No | Path to the `kaleido` binary, for the node lifecycle tools |
| `KALEIDO_NODE_URL` | No | Node URL passed as `--node-url` to the node lifecycle tools |
| `KALEIDO_API_URL` | No | API URL passed as `--api-url` to the node lifecycle tools, and a fallback for `KALEIDOSWAP_API_URL` |
Expand Down Expand Up @@ -253,7 +264,7 @@ Add a server to an MCP host such as Claude Desktop or Claude Code. `npx` works f
"mcpServers": {
"kaleido": {
"command": "npx",
"args": ["-y", "kaleido-mcp"],
"args": ["-y", "-p", "kaleido-mcp", "-p", "@tetherto/wdk-wallet-spark", "kaleido-mcp"],
"env": {
"KALEIDO_NETWORK": "signet",
"WDK_SEED": "your twelve word seed phrase",
Expand All @@ -269,7 +280,7 @@ claude mcp add kaleido \
--env KALEIDO_NETWORK=signet \
--env RLN_NODE_URL=http://localhost:3001 \
--env WDK_SEED="your twelve word seed phrase" \
-- npx -y kaleido-mcp
-- npx -y -p kaleido-mcp -p @tetherto/wdk-wallet-spark kaleido-mcp
```

```json wdk-wallet-mcp
Expand Down Expand Up @@ -302,7 +313,7 @@ claude mcp add kaleido \
```
</CodeGroup>

On Claude Desktop the file is `claude_desktop_config.json` (**Settings > Developer > Edit Config**). `WDK_SEED` is optional: leave it out and the Spark tools are disabled while the RGB node, DEX, payment and market tools keep working. The standalone Spark server takes no network preset, so it sets `SPARK_NETWORK` directly; `REGTEST` is the name the Spark SDK gives its hosted test network.
On Claude Desktop the file is `claude_desktop_config.json` (**Settings > Developer > Edit Config**). `WDK_SEED` and the `@tetherto/wdk-wallet-spark` package are optional: leave them out and the Spark tools are disabled while the RGB node, DEX, payment and market tools keep working. The standalone Spark server takes no network preset, so it sets `SPARK_NETWORK` directly; `REGTEST` is the name the Spark SDK gives its hosted test network.

## First Run

Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/ai-tools/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ The [KaleidoMind](/ai-tools/kaleido-mind) repository ships its bundled skills as
/plugin install kaleido-mind@kaleidoswap
```

The plugin runs `npx -y kaleido-mcp` with `KALEIDO_NETWORK=signet`. Set `RLN_NODE_URL` to point at your RGB Lightning Node and `WDK_SEED` to enable the Spark wallet tools. Some KaleidoMind skills (Spark wallet, Bitrefill, Flashnet, merchant finder) rely on tools that only the KaleidoMind runtime provides.
The plugin runs `npx -y kaleido-mcp` with `KALEIDO_NETWORK=signet`. Set `RLN_NODE_URL` to point at your RGB Lightning Node. The plugin does not install the optional Spark wallet package; to use the Spark tools, configure `kaleido-mcp` yourself as shown in [MCP Servers](/ai-tools/mcp-servers#client-configuration). Some KaleidoMind skills (Spark wallet, Bitrefill, Flashnet, merchant finder) rely on tools that only the KaleidoMind runtime provides.

2 changes: 1 addition & 1 deletion mintlify-docs/ai-tools/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ description: "Fix common KaleidoSwap AI tool problems, covering MCP connection f
<Accordion title="Server starts then exits immediately" icon="circle-xmark">
**Symptoms**: The host reports the process died on launch.

**Cause**: A required environment variable is missing. The standalone `wdk-wallet-spark-mcp` refuses to start without `WDK_SPARK_SEED`. `kaleido-mcp` is more forgiving: without `WDK_SEED` it still boots, logs a warning, and disables the Spark tools.
**Cause**: A required environment variable is missing. The standalone `wdk-wallet-spark-mcp` refuses to start without `WDK_SPARK_SEED`. `kaleido-mcp` is more forgiving: without `WDK_SEED`, or without the optional `@tetherto/wdk-wallet-spark` package, it still boots, logs a warning or install hint, and disables the Spark tools. On `KALEIDO_NETWORK=mainnet` it does refuse to start without `KALEIDOSWAP_API_URL`, since there is no public mainnet API.

**Solutions**:
1. Confirm the seed variable is set in the `env` block of the host config, not in your shell (the host does not inherit your shell environment).
Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/api-reference/additional-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Integrate against Signet before mainnet. No API key is required today, and anony
| Environment | REST base URL | WebSocket |
|-------------|---------------|-----------|
| **Signet (MutinyNet)** | `https://api.signet.kaleidoswap.com/api/v1` | `wss://api.signet.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Mainnet** | `https://api.kaleidoswap.com/api/v1` *(coming soon)* | `wss://api.kaleidoswap.com/api/v1/market/ws/{client_id}` *(coming soon)* |
| **Mainnet** | No public endpoint yet: use your own maker's URL | — |

Asset IDs are not portable between environments — read them from `GET /api/v1/market/assets` and key your configuration per environment.

Expand Down
4 changes: 2 additions & 2 deletions mintlify-docs/api-reference/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ description: "Common questions about the KaleidoSwap swap API, covering authenti
</Accordion>

<Accordion title="Which environments can I integrate against?" icon="network-wired">
Signet (MutinyNet) is live today; mainnet is coming soon.
Signet (MutinyNet) is live today. There is no public mainnet endpoint yet; for mainnet, point your integration at your own maker's URL.

| Environment | REST base URL | WebSocket |
|-------------|---------------|-----------|
| **Signet** | `https://api.signet.kaleidoswap.com/api/v1` | `wss://api.signet.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Mainnet** | `https://api.kaleidoswap.com/api/v1` *(coming soon)* | `wss://api.kaleidoswap.com/api/v1/market/ws/{client_id}` *(coming soon)* |
| **Mainnet** | No public endpoint yet: use your own maker's URL | — |

The interactive playground on the endpoint pages runs against Signet.
</Accordion>
Expand Down
4 changes: 1 addition & 3 deletions mintlify-docs/api-reference/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ A public testnet with realistic network conditions, recommended for integration
- **Base URL:** `https://api.signet.kaleidoswap.com/api/v1`

### Bitcoin Mainnet (Coming Soon)
The mainnet environment is the production-ready endpoint for live transactions. Stay tuned for updates about its release.

- **Base URL:** `https://api.kaleidoswap.com/api/v1`
There is no public mainnet endpoint yet. To integrate on mainnet, point your client at your own maker's base URL; the API paths are the same as on Signet.

---

Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/api-reference/swap-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Retrieve the public identity of the maker's RGB Lightning Node — its pubkey, t
| Environment | URL |
|-------------|-----|
| **Signet** | `wss://api.signet.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Mainnet** | `wss://api.kaleidoswap.com/api/v1/market/ws/{client_id}` *(coming soon)* |
| **Mainnet** | No public endpoint yet: use your own maker's URL |

### Description
Establish a WebSocket connection to request live quotes from the maker. The protocol is request/response: the client sends a message and the server replies to that message. There is no subscription mechanism — to keep a price fresh, send a new `quote_request` whenever you need an updated quote.
Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/api-reference/swap-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Taker Client Maker (RGB-LSP) Taker RLN
| Environment | URL |
|-------------|-----|
| **Signet** | `wss://api.signet.kaleidoswap.com/api/v1/market/ws/{client_id}` |
| **Mainnet** | `wss://api.kaleidoswap.com/api/v1/market/ws/{client_id}` *(coming soon)* |
| **Mainnet** | No public endpoint yet: use your own maker's URL |

Replace `{client_id}` with a unique identifier for your session.

Expand Down
2 changes: 1 addition & 1 deletion mintlify-docs/cn/ai-tools/build-local-rgb-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ RGB 资产依附在比特币 UTXO 上,因此节点在接收任何资产之前
KALEIDO_NETWORK=signet RLN_NODE_URL=http://localhost:3001 npx -y kaleido-mcp
```

服务器会输出 `network: signet` 并在 stdio 上等待。你不需要手动保持它运行:下一步中的代理会把它作为子进程启动。这里 `WDK_SEED` 是可选的;不设置时 Spark 工具保持关闭,RGB、DEX、支付和行情工具照常可用。全部变量见 [MCP 服务器](/cn/ai-tools/mcp-servers#network-preset)。
服务器会输出 `network: signet` 并在 stdio 上等待。你不需要手动保持它运行:下一步中的代理会把它作为子进程启动。这里 `WDK_SEED` 是可选的,而且普通的 `npx` 不会安装 Spark 钱包包;缺少它们时 Spark 工具保持关闭,RGB、DEX、支付和行情工具照常可用。全部变量见 [MCP 服务器](/cn/ai-tools/mcp-servers#network-preset)。

<Tip>
想在写代码之前先试用这些工具?用[客户端配置](/cn/ai-tools/mcp-servers#client-configuration)中的配置把同一条命令添加到 Claude Desktop 或 Claude Code,然后询问你的 RGB 余额。本教程余下部分会把这个托管模型换成本地模型。
Expand Down
4 changes: 2 additions & 2 deletions mintlify-docs/cn/ai-tools/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ description: "选择把 AI 代理接入比特币的方式:MCP 服务器、Kale
| 要求 | 说明 |
|-------------|---------|
| **一个测试网络** | signet。KaleidoSwap API 在 `https://api.signet.kaleidoswap.com` 提供 signet 实例,[RGB 水龙头](https://faucet.mutinynet.kaleidoswap.com)可发放测试资产。首次运行绝不要用主网 |
| **一份钱包种子** | 用于测试网络的一次性 BIP-39 助记词,设置到 `WDK_SEED` |
| **一个节点** | 仅 `wdk_*` 工具和原子交换需要。[KaleidoCLI](/cn/cli/installation) 一条命令即可启动一个 signet RGB Lightning Node。Spark 工具只需要种子,行情数据什么都不需要 |
| **一份钱包种子** | 仅 Spark 工具需要:用于测试网络的一次性 BIP-39 助记词,设置到 `WDK_SEED`,并安装可选的 Spark 钱包包(见 [MCP 服务器](/cn/ai-tools/mcp-servers)) |
| **一个节点** | 仅 `wdk_*` 工具和原子交换需要。[KaleidoCLI](/cn/cli/installation) 一条命令即可启动一个 signet RGB Lightning Node。Spark 工具需要种子和 Spark 钱包包,行情数据什么都不需要 |
| **一个 MCP 宿主或 LLM 密钥** | Claude Desktop 或其他 MCP 客户端,或者用于 KaleidoAgent 的 Anthropic / OpenAI 密钥 |

如果你还没有安装任何组件,请先看[安装](/cn/ai-tools/installation)。想从一台空机器一路走到让本地模型在 signet 上操作 RGB 资产,请按照[构建本地 RGB 代理](/cn/ai-tools/build-local-rgb-agent)操作。
Expand Down
2 changes: 2 additions & 0 deletions mintlify-docs/cn/ai-tools/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ KALEIDO_NETWORK=signet npx -y kaleido-mcp
请运行一次 `npx -y kaleido-mcp@latest`。
</Note>

自 0.3.1 起,Spark 和 Liquid 钱包是可选的,普通的 `npx` 不会安装它们。如需启用,请运行 `npx -y -p kaleido-mcp -p @tetherto/wdk-wallet-spark -p @kaleidorg/wdk-wallet-liquid kaleido-mcp`,并设置 `WDK_SEED` / `LIQUID_MNEMONIC`。

使用 RGB 工具还需要一个 RGB Lightning Node。[KaleidoCLI](/cn/cli/installation) 可以在 Docker 中运行一个 signet 节点,完整流程见[构建本地 RGB 代理](/cn/ai-tools/build-local-rgb-agent)。

另有三个按钱包划分的服务器 `wdk-wallet-mcp`、`wdk-wallet-spark-mcp` 和 `wdk-wallet-liquid-mcp`,它们保持独立而未并入网关,需要从源码构建:
Expand Down
Loading
Loading