Get the status history of a monitor.
Use when:
You want to see the timeline of a monitor's state changes (e.g. active, disabled, errored) and any related details.
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No | CatchAll API key. Optional if provided via x-api-key header or CATCHALL_API_KEY env var. | |
| monitor_id | Yes | The monitor ID to inspect. |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses that the tool returns a timeline of states but does not mention permissions, rate limits, or destructive potential. However, the tool is read-only by nature, and the description adequately conveys its non-destructive behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise (two sentences) and front-loaded with the core purpose, with zero extraneous words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists and the tool is simple, the description covers the main purpose and usage. It does not mention pagination or filtering, but for a history tool this is acceptable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description does not add any additional meaning to the parameters beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool gets 'status history of a monitor', which is a specific verb and resource. It distinguishes from sibling tools like get_dataset_status by focusing on monitor state changes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description includes a 'Use when' section that explicitly lists scenarios (timeline of state changes), providing clear context for when to invoke this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool is scoped to a specific resource type and action, with clear distinctions between similarly named operations (e.g., pull_results vs pull_job_csv, initialize_query vs validate_query). No two tools appear to perform the same function.
Tools consistently use snake_case verb_noun patterns (create_X, get_X, list_X, update_X, delete_X), with domain-specific verbs like submit, pull, initialize, and validate adding semantic clarity. Minor deviations such as pull_* vs get_* and compound names like create_dataset_from_csv are still predictable.
At 60 tools, the server is heavily overstuffed for a single MCP surface. While the broad domain (datasets, entities, jobs, monitors, projects, webhooks) justifies many operations, the sheer volume exceeds typical recommended limits and includes near-duplicates (pull_results vs pull_job_csv, get_dataset vs get_dataset_status), making agent tool selection unwieldy.
The tool set provides robust CRUD and lifecycle coverage for all major resources, including special operations like csv import, webhook mapping, and monitor enable/disable. Minor gaps such as the absence of a get_monitor (single monitor details) and no cancel_job can be worked around via list_monitors and waiting for job completion.