Skip to content

monitor create: document goal / judgeEnabled #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
developersdigest wants to merge 1 commit into
base: main
Choose a base branch
from
Open

monitor create: document goal / judgeEnabled #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/monitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ export function registerMonitorTools(server: FastMCP<SessionData>): void {
description: `
Create a Firecrawl monitor — a recurring scrape or crawl that diffs each result against the last retained snapshot.

Pass the full request body. Required fields: \`name\`, \`schedule\` (with \`cron\` or \`text\`), and \`targets\` (one or more \`{ type: 'scrape', urls: [...] }\` or \`{ type: 'crawl', url: '...' }\`). Optional: \`webhook\`, \`notification\`, \`retentionDays\`.
Pass the full request body. Required fields: \`name\`, \`schedule\` (with \`cron\` or \`text\`), and \`targets\` (one or more \`{ type: 'scrape', urls: [...] }\` or \`{ type: 'crawl', url: '...' }\`). Optional: \`webhook\`, \`notification\`, \`retentionDays\`, \`goal\`, \`judgeEnabled\`.

**Meaningful-change judge:** Set \`goal\` to a plain-language description of what you actually care about (e.g. \`"tell me when pricing changes"\`) and the API will run an AI judge on each diff, exposing \`isMeaningful\` on the \`monitor.page\` webhook. \`judgeEnabled\` defaults to true when \`goal\` is set, so just providing \`goal\` is enough.

**Markdown-mode (default):** Each check produces a unified text diff of the page's markdown. No extra configuration needed.

Expand Down
Loading