Spoolis docs
MCP server
The Spoolis Model Context Protocol server runs over stdio. It uses a short-lived demo session without an API key and preserves bearer-authenticated v1 behavior when a key is configured.
Run the server
Run npx @spoolis/mcp after the package is published, or use npm run mcp from this repository. Without an API key, the server starts in demo mode against https://spoolis.com. Set SPOOLIS_BASE_URL to override the sandbox host. With SPOOLIS_API_KEY, SPOOLIS_API_URL defaults to https://spoolis.com; set it to http://localhost:3000 for local development.
npx @spoolis/mcp
npm run mcp
SPOOLIS_API_KEY=spk_live_example npx @spoolis/mcpConfigure Claude Code
Add a stdio server that runs the npm package. Add the environment block only for authenticated mode.
{
"mcpServers": {
"spoolis": {
"command": "npx",
"args": ["-y", "@spoolis/mcp"],
"env": {
"SPOOLIS_API_KEY": "spk_live_example",
"SPOOLIS_API_URL": "https://spoolis.com"
}
}
}
}Configure Cursor
Cursor accepts the same stdio command shape in its MCP configuration.
{
"mcpServers": {
"spoolis": {
"command": "npx",
"args": ["-y", "@spoolis/mcp"],
"env": { "SPOOLIS_API_KEY": "spk_live_example" }
}
}
}Tools
compile_spoolcreate_spoolget_spoolcreate_counterparty_invitepropose_spoolaccept_spoolabandon_spooldecline_spoolcancel_spoolcommit_paymentsubmit_evidenceverify_spoolcomplete_spoolget_spool_eventsSpoolis determines earned value and signs the Outcome Receipt. A wallet, marketplace, payment system, or configured integration may verify and consume it, then act under its own authorization and settlement policy.
In the canonical example, a buyer pays for 100 enrichment records at $1.00 per accepted record. Spoolis accepts 98, rejects 2 with reasons, and signs an Outcome Receipt for $98.00 earned. The recipe order is compile, verify, receipt, verifyReceipt, optional GET /api/receipts/{id}/status, then act on earned. Offline signature verification remains sufficient. In demo mode, tools with sandbox equivalents label their results as demo.
The optional built-in path uses a configured settlement adapter. commit_payment asks that adapter to authorize and, where supported, place a provider-managed authorization hold. Spoolis does not hold funds. complete_spool only reads an already completed Spool.