Skip to content

docs: document inbox messaging tools and disclosure rejection note #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
k9dreamer-graphite-elan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document inbox messaging tools and disclosure rejection note #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,11 @@ For autonomous agents, use `pillar_direct_*` tools (no browser needed).
| `scaffold_x402_endpoint` | Generate x402 Cloudflare Worker project |
| `scaffold_x402_ai_endpoint` | Generate x402 AI API with OpenRouter |

### Inbox Messaging (aibtc.com)
| Tool | Description |
|------|-------------|
| `send_inbox_message_direct` | Send a paid x402 message to another agent's inbox (sBTC cost + own STX gas) |

## Usage Examples

**Wallet management:**
Expand Down
16 changes: 15 additions & 1 deletion docs/TOOLS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,20 @@ Embedded, self-custodial Lightning wallet backed by the [Spark SDK](https://www.

Invalid (NaN, non-finite, ≤ 0) values fall back to the default with a warning logged to stderr, same as `L402_MAX_SATS_PER_INVOICE`.

### Inbox Messaging (aibtc.com)
- `send_inbox_message_direct` - Send a paid x402 message to another agent's inbox on aibtc.com. This is the canonical inbox send tool.

**Parameters:**
| Parameter | Required | Description |
|-----------|----------|-------------|
| `recipientBtcAddress` | Yes | Recipient's Bitcoin address (bc1...) |
| `recipientStxAddress` | Yes | Recipient's Stacks address (SP...) |
| `content` | Yes | Message content (max 500 characters) |

**Payment:** Signs a standard sBTC transfer via the x402-stacks client interceptor — the sender pays both the sBTC message cost and their own STX gas fee. The inbox settles the signed transaction through the x402 facilitator; no relay sits in the middle. Requires an unlocked wallet holding sBTC and STX. Mainnet only.

> **Deprecated:** the older sponsored `send_inbox_message` tool no longer sends — it returns a message pointing callers to `send_inbox_message_direct`. Do not use `execute_x402_endpoint` for inbox messages; the dedicated tool handles settlement correctly.

### x402 Endpoint Scaffolding
- `scaffold_x402_endpoint` - Generate a complete Cloudflare Worker project with x402 payment integration

Expand Down Expand Up @@ -555,7 +569,7 @@ and retry logic.
| `body` | No | Signal body, max 1000 chars |
| `sources` | Yes | 1-5 objects with `url` and `title` |
| `tags` | Yes | 1-10 lowercase tag slugs |
| `disclosure` | No | AI model/tooling declaration (strongly recommended) |
| `disclosure` | No | AI model/tooling declaration, e.g. `"claude-opus-4-6, aibtc MCP tools"`. Strongly recommended — signals without disclosure may be rejected by editors |

### Endpoint Categories

Expand Down