Tools - Scrip Docs

Scrip MCP exposes task-oriented tools for operating a whole rewards program. Most tools answer a complete operator question, such as “why did this event fail?” or “where did this balance come from?” Every tool name starts with scrip_. Dedicated write tools do not register at https://mcp.scrip.dev/mcp while it is read-only. scrip_test_run and scrip_test_rule_configuration still register so you can fetch an existing run. Starting a run needs writes and is rejected.

Programs and reporting

Tool	Type	Use it to
`scrip_ping`	View	Confirm that the connection is active.
`scrip_get_program_overview`	View	Inspect program configuration, assets, rules, and tiers.
`scrip_get_program_analytics`	View	Pull activity, liability, expiration, and ledger integrity for a period.
`scrip_explain_event`	View	Trace an event through rule evaluation and ledger entries.
`scrip_get_event_shapes`	View	Sample recent event payloads by type and check them against the fields rules read.
`scrip_get_rule_configuration`	View	Read every set and non-archived rule in exact execution order with the current revision.

Participants and groups

Tool	Type	Use it to
`scrip_search_participants`	View	Find a participant by name, state, or filter.
`scrip_get_participant_context`	View	Explain a participant, their state, and their balance.
`scrip_search_groups`	View	Find a group or shared wallet.
`scrip_get_group_context`	View	Explain a group, its wallet, and its state.
`scrip_list_group_lots`	View	List a group’s lots by status, reference, or expiry.
`scrip_get_group_statement`	View	Reconcile a group wallet over a window with running balances.
`scrip_adjust_balance`	Change	Apply an audited credit or debit to a participant balance.

Redemptions and rewards

Tool	Type	Use it to
`scrip_get_rewards_catalog`	View	Browse rewards, costs, status, and availability.
`scrip_list_redemptions`	View	List a participant’s redemptions.
`scrip_get_redemption_context`	View	Inspect fulfillment status, reservation deadline, ledger entries, failure detail, and reversal history.
`scrip_reverse_redemption`	Change	Reverse or refund a redemption.

Rules

Tool	Type	Use it to
`scrip_list_rule_sets`	View	List rule sets in execution order, including the automatic `default` set.
`scrip_list_rules`	View	Review rules in a program.
`scrip_get_rule`	View	Inspect one rule.
`scrip_validate_cel`	View	Check a CEL condition for syntax and common mistakes.
`scrip_test_rule`	View	Simulate a draft or saved rule. Nothing is saved.
`scrip_test_run`	View or Change	Fetch an existing program test run, or start one when writes are enabled. Ledger effects roll back. Starting persists a test-run record.
`scrip_create_or_update_rule_set`	Change	Create a named rule set or update its display name and order.
`scrip_create_or_update_rule`	Change	Save a rule after validating and testing it.
`scrip_plan_rule_configuration`	View	Turn semantic multi-set changes into a server-validated preview with the exact final sequence, diff, warnings, and apply capability.
`scrip_test_rule_configuration`	View or Change	Fetch an existing configuration test run, or start one when writes are enabled. Starting persists a test-run record.
`scrip_lint_rule_configuration`	View	Analyze set-local stops, snapshot dependencies, effects, windows, budgets, and ordering across a complete draft.
`scrip_apply_rule_configuration`	Change	Apply the exact preview token and request hash after approval.
`scrip_get_rule_configuration_history`	View	List, inspect, diff, reconstruct, or preview rollback for immutable configuration revisions.

Documentation and API coverage

Tool	Type	Use it to
`scrip_search_docs`	View	Search Scrip guides, rule docs, and API reference.
`scrip_fetch_doc`	View	Fetch a specific docs page.
`scrip_api_get`	View	Call a `GET /v1/...` endpoint that does not have a dedicated MCP tool.
`scrip_api_mutate`	Change	Call a `POST`, `PUT`, `PATCH`, or `DELETE /v1/...` endpoint that does not have a dedicated MCP tool.

Use scrip_search_docs before drafting rules or calling unfamiliar endpoints. Prefer a dedicated tool when one covers the task. Use scrip_api_get or scrip_api_mutate only when no dedicated tool exists.

Changing data

The hosted server is currently read-only. Dedicated write tools, such as saving a rule, applying a configuration, adjusting a balance, and reversing a redemption, do not appear on https://mcp.scrip.dev/mcp. scrip_test_run and scrip_test_rule_configuration still appear. Starting a run needs writes and is rejected. Pass test_run_id to fetch a run that already exists. Dedicated write tools register only when the deployment enables writes, and only when the connection can write. Your MCP client may also ask for approval before a change runs. Scrip records changes through the same audited API paths used by the dashboard and REST API. On the hosted server, simulate one rule with scrip_test_rule and plan a draft with the configuration workflow above. Start a configuration test run from the REST API. Apply, save, adjust, and reverse from the dashboard or REST API until hosted write-mode is enabled.

​Programs and reporting

​Participants and groups

​Redemptions and rewards

​Rules

​Documentation and API coverage

​Changing data