Valuein
Discovery

Test Rule (dry run)

test_rule
Benchmark and above

Dry-run a rule's condition_expr against a SYNTHETIC trigger payload — reports whether it WOULD have fired, but NEVER dispatches the action (no report generated, no team run, no message sent, no inbox write). Use this immediately after create_rule to sanity-check the condition ...

Example Call

example_call.pypython
# Using the Valuein MCP server from Python (via MCP SDK)# Or call directly from Claude / Cursor after setup result = await client.call_tool(    "test_rule",    arguments={    "rule_id": "EXAMPLE"})print(result)

Direct tool call:test_rule(...)

Inputs

ParameterTypeRequiredDescription
rule_idstring
required
Identifier of the rule to dry-run, from create_rule or list_rules.
sample_payload_overrideobjectoptionalMerged over the built-in synthetic payload for this rule's trigger_type — lets you test a specific value.

Output Fields

rule_idwould_firereasonsynthetic_payloadaction_typenote

Example Response

Illustrative
response.jsonjson
{  "rule_id": null,  "would_fire": null,  "reason": null,  "synthetic_payload": null,  "action_type": null,  "note": null}

Shape only — field names match the live schema; values are placeholders, not real filings. See MCP server for the structured response shape.

Notes

Available from the Benchmark plan and above.

Try this tool

Get tokenAll tools
CategoryDiscovery
PIT-safeNo
Min planBenchmark
Inputs2 (1 required)

Plan Access

Sample (guest)
Not included
Benchmark (token)
Available
Pro
Available
Institutional
Available

Related Tools

search_companies

Search Companies

get_company_fundamentals

Company Fundamentals

get_valuation_metrics

Valuation Metrics

get_financial_ratios

Financial Ratios

Resources

Point-in-Time methodology →Parquet schema reference →Bulk Data API reference →Python SDK guide →

Index names are trademarks of their owners; Valuein is not affiliated with or endorsed by any index provider.