Skip to main content

Overview

The bigdata_create_monitor tool creates a search monitor in your Bigdata.com account from a plain-language intent. Every other field is optional. Anything you set is pinned, so it is used as given instead of being drafted from the intent. Create always saves the monitor inactive. Preview it, read its runs, then turn it on with bigdata_edit_monitor. The returned monitor id is the handle for every follow-up: fetch it with bigdata_get_monitor, preview it with bigdata_simulate_monitor, read its results with bigdata_get_monitor_runs, change or activate it with bigdata_edit_monitor, or remove it with bigdata_delete_monitor.

When to Use

Create Monitor is ideal for:
  • Tracking events: Watching for regulatory actions, rating changes, management changes, or any other recurring event
  • Watching a set of companies: Running the same question on a schedule across a list of entities
  • Extracting structured fields: Turning each match into a fixed set of fields, such as company, amount, and stage
Entities must be RavenPack entity IDs, not company names or tickers. Resolve them with find_securities first.

How It Works

  1. Create the monitor with an intent and any fields you want to pin. It is saved inactive
  2. Show the returned configuration to the user
  3. Preview it with a flash run of bigdata_simulate_monitor
  4. Read the results with bigdata_get_monitor_runs
  5. Activate it with bigdata_edit_monitor by setting status to active. Add email delivery only if the user asked for it

Parameters

Here only entities, name, and schedule are pinned. The search queries and the structured output schema are drafted from the intent. See the response.

Important Notes

  • The monitor is always created inactive
  • Pinned fields are used as given and are not drafted from the intent
  • structured_output and delivery cannot be set at creation. The schema is drafted from the intent. Change it, or add delivery, with bigdata_edit_monitor
  • If the monitor cannot be generated, the tool returns the rejection text from the API
  • A smart-mode or malformed search query is rejected

Shared Shapes

These shapes are used by bigdata_create_monitor and bigdata_edit_monitor.

Schedule

Send exactly one of frequency or cron. timezone is only allowed with cron and defaults to UTC.
  • frequency is a count plus h, d, or w (for example 4h, 2d, 1w), at most 31 days
  • cron has 5 fields. The minute must be a single value, so runs are at least an hour apart
  • A cron can set the day of month or the day of week, not both, and must run at least once every 31 days
  • Responses rebuild the unit from the stored hours, so 48h can come back as 2d

Search queries

A list of raw JSON strings. Each string is one fast-mode bigdata_search payload. Smart mode is rejected.
Before storing, the MCP server:
  • Drops filters.timestamp, max_chunks, and reranking. The reranker is stored disabled
  • Merges payloads that share filters into one multi-text search
  • Wraps each search as {"query": {...}}
The example above is stored as:

Entities

RavenPack entity IDs from find_securities. When set, the list must contain at least one ID, up to the maximum watchlist size. Duplicate IDs are collapsed. The IDs are stored as one watchlist group:

Structured output

A flat map of field name to {description, field_type, values, read_only}. Only field_type is always required.
  • field_type is one of entity_reference, number, enum, ordered_enum, string, boolean, datetime, list, range, currency, reference_period, or text
  • values is required for enum and ordered_enum
  • The map ends with the read-only system fields announcement_date, effective_date, and summary

Delivery

The only accepted value is {"type": "email"}, which emails the monitor owner. Any extra field, such as an address, is rejected.

Data Returned

Returns the monitor detail as structuredContent. The same detail is returned by bigdata_edit_monitor and by bigdata_get_monitor with an id. The result also comes as markdown: an overview table, JSON blocks for the search queries and the structured output schema, then the extraction instructions if they are set.

Practical Tips

Pin only what you know

Start with just an intent. Pin search_queries, entities, or schedule only when the user has been specific, so the rest can be drafted from the intent.

Preview before activating

A new monitor does not run on a schedule or send email. Run a flash preview and read the results before turning it on.