RevRule by Payload

io.github.payload-toolsPublished by GitHub account payload-toolsv1.1.0Updated Oct 25, 2026

RevRule by Payload: read entitlement graphs, review payout evidence, dry-run revenue events.

The publisher's own server: Video Transcript

VerifiedSTDIODesktop onlyFinanceData & Analytics

Overview

AI-generated overview

A local MCP server that lets an assistant read RevRule revenue entitlement graphs, review payout evidence, and dry-run revenue events on Payload's rail.

What you can do
Fetch a RevRule entitlement graph by id, including participants, rules and ledger wiring (read-only). List payout evidence for a graph, with verified payouts linked to entitlement ledger entries and settlement data (read-only). Dry-run a revenue event against a graph's rules to see what they would produce, with no side effects.
When to use it
Useful when you work with Payload RevRule revenue-sharing setups and want an assistant to inspect entitlement graphs, check payout evidence, or test how rules would treat a revenue event before anything is submitted.
Requirements
Runs locally over stdio as a Node.js process, installed from the MCPB bundle or run from source. Needs a Payload rail API key in the PAYLOAD_RAIL_API_KEY environment variable; a free self-serve key works for evaluation. Network access to the Payload rail is required, with an optional PAYLOAD_RAIL_URL override.
Before you install
Requires your own Payload rail API key, which is sent as a Bearer Authorization header to the rail. Without a key, every tool call fails. The server is read and dry-run only, so it does not submit payouts, but graph and payout data come from a third-party rail service. Production use is described as covered by a paid license.

Installation

In SourceWeft

  1. Open RevRule by Payload in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

RevRule by Payload — MCP Server

An MCP server (stdio transport, Node.js standard library only, zero dependencies) that exposes RevRule, Payload's revenue-entitlement engine, to AI agents.

RevRule turns revenue sharing into declarative entitlement rules on the Payload rail: define who gets paid what, and every payout carries evidence linked back to the original entitlement ledger entry and its on-chain settlement. This server is a read + dry-run surface: there are deliberately no write/submit tools in v1. Every call goes to the live Payload rail (https://payload-rail.fly.dev) authenticated with your own rail API key (a free self-serve key from the console is enough to evaluate).

Tools

ToolUpstream routeWhat it does
revrule_get_graphGET /v1/graphs/{graph_id}Fetch one of your RevRule revenue entitlement graphs by id: its participants, rules, and ledger wiring. Read-only.
revrule_list_payout_evidenceGET /v1/graphs/{graph_id}/payout-evidenceList payout evidence recorded for a graph: verified payouts linked back to the original entitlement ledger entries (transaction hash, log index, block data, authorizing signature). Read-only.
revrule_simulate_eventPOST /v1/graphs/{graph_id}/simulateDry-run a revenue event against a graph's rules and see what the rules would produce, with zero side effects: nothing is recorded, no payout is prepared or submitted. The tool wraps the supplied event as {event: ...} for the production rail; simulation has no side effects.

Install

Verified MCPB release

Install the revrule v1.1.0 MCPB bundle in an MCPB-compatible client, or run from source below. The published bundle declares the supported MCP tools. This direct release is the verified installation path while third-party directory listings are revalidated.

From source

bash
git clone https://github.com/Payloadhq/revrule-mcpcd revrule-mcpnode mcp/index.js

Or run it straight from GitHub with npx:

bash
npx -y github:Payloadhq/revrule-mcp

MCP client configuration (stdio):

json
{  "mcpServers": {    "revrule": {      "command": "node",      "args": ["/path/to/revrule-mcp/mcp/index.js"],      "env": {        "PAYLOAD_RAIL_API_KEY": "your-rail-api-key"      }    }  }}

Configuration

VariableRequiredDefaultPurpose
PAYLOAD_RAIL_API_KEYRequired for tool calls—Your own Payload rail API key. A free self-serve key from the console works for evaluation; the paid license covers production use. Sent to the rail only as a Bearer Authorization header.
PAYLOAD_RAIL_URLOptionalhttps://payload-rail.fly.devPayload rail base URL.

Fail-closed: with no API key configured, the server still starts and lists its tools, and every tool call returns a clear API key not configured error. The key never leaves your machine except as the Authorization header to the rail.

Free evaluation and the paid license

Free. You can evaluate RevRule end to end without paying:

  • The RevRule sandbox runs the actual engine in your browser: define a graph, fire events, and inspect the entitlement ledger.
  • The RevRule console issues a free self-serve Payload rail API key. With that key, this server's reads (revrule_get_graph, revrule_list_payout_evidence) and the zero-side-effect dry run (revrule_simulate_event) work against your own graphs. A paid entitlement is not required to evaluate.

Paid. The RevRule license is $99 one-time. It is the production product: run your real revenue graphs on the rail with the entitlement ledger and payout evidence as your system of record, instead of evaluating in the sandbox.

RevRule computes who is owed what and records the evidence. It does not execute payments and it never holds funds; your own systems and payment partners move the money.

License

MIT — see LICENSE.


RevRule is a product of Payload, separate from Veyline (Payload's authorization layer) and from callx402 by Payload, the MCP client layer for x402-priced actions.

Source: README.md at commit 3f7a06e

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

3
  1. v1.1.0LatestOct 16, 2026
  2. v1.0.1Oct 16, 2026
  3. v1.0.0Oct 13, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

Other Payload integrations