Tools
Exactly what the server advertised in the scan completed . Effects and capabilities are classified by Squatch from each tool's metadata. Squatch never runs tools.
- Effect: Read 52
- Effect: Write 47
- Effect: Delete 3
Showing 102 of 102 tools
| Details | ||
|---|---|---|
| delete_calendar_event Permanently delete a calendar event in this farm. ALWAYS ask the user to confirm first. | Effect: Delete | |
| delete_farm_note Delete a Farm Note. confirm:true. | Effect: Delete | |
| delete_task Permanently delete a task in this farm. ALWAYS ask the user to confirm first. | Effect: Delete | |
| activate_rentahatch_booking Manually mark a rental paid/active (pending_payment → active). SuperAdmin only. confirm:true. | Effect: Write | |
| adjust_inventory_stock Add (positive) or deduct (negative) stock for one General Inventory product with a required reason; writes an inventoryAdjustments record e… | Effect: Write | |
| complete_production_order Mark a manufacturing production order Completed, exactly like the app's Complete button: deducts each BOM component's quantityActuallyUsed,… | Effect: Write | |
| complete_task Mark a task as Completed and update recurrence. Supports confirm and idempotency validation. | Effect: Write | |
| create_calendar_event Create a new calendar event on the farm’s timeline. Supports confirm and idempotency validation. | Effect: Write | |
| create_customer Add a new customer to the CRM with deduping. Supports confirm and idempotency validation. | Effect: Write | |
| create_farm_note Create a Farm Note (content + optional date YYYY-MM-DD). confirm:true to commit. createdBy=manual. | Effect: Write | |
| create_feature_request Submit a new feature request or upvote an existing matching request. ALWAYS ask for confirmation before writing. | Effect: Write | |
| create_hive Register a new beehive in an apiary yard. ALWAYS ask for confirmation before writing. | Effect: Write | |
| create_inventory_product Create a General Inventory product (optionally manufactured, with a BOM recipe). SKU must be unique in the farm. Supports confirm (false = … | Effect: Write | |
| create_production_order Create a new Draft manufacturing production order for a product with a valid BOM recipe. Supports confirm and idempotency validation. | Effect: Write | |
| create_sales_order Create a new sales order, updating inventory, transactions, and customer totals in a single transaction. Supports confirm and idempotency v… | Effect: Write | |
| create_supplier_shipment Create a Draft Bulk-Supply farm shipment (Sell Parts) for this farm. Enforces campaign.minQuantity (e.g. 20 pairs for wings) and monthlyLim… | Effect: Write | |
| create_support_ticket Create a new support ticket. ALWAYS ask for confirmation before writing. | Effect: Write | |
| create_task Create a new farm management task. Supports confirm and idempotency validation. | Effect: Write | |
| draft_email_reply Create a reply DRAFT for an Email Assistant conversation. Never sends. The draft is saved in the farm's Email Assistant (it pre-fills the r… | Effect: Write | |
| enroll_academy_course Enroll this farm in a free QuailOS Academy course (or preview free eligibility for plan tier). Requires owner, admin, or manager role. Paid… | Effect: Write | |
| get_make_money_with_quail_guide Signup-oriented guide for making money via Supply Opportunities (Undique buying product from farms). Clarifies that /make-money-with-quail … | Effect: Write | |
| log_bird_batch Log a new bird inventory census batch. Supports confirm and idempotency validation. | Effect: Write | |
| log_candling Log egg candling fertility results for an active batch. ALWAYS ask for confirmation before writing. | Effect: Write | |
| log_eggs Log a new daily egg collection count. Supports confirm and idempotency validation. | Effect: Write | |
| log_feed_purchase Log a feed purchase and automatically increment feed assets inventory. Supports confirm and idempotency validation. | Effect: Write | |
| log_hatch_result Complete a batch by logging final hatch count, calculating stats, and optionally creating a bird batch. ALWAYS ask for confirmation before … | Effect: Write | |
| log_hatch_set Start a new incubation batch, auto-calculating lockdown/hatch dates. ALWAYS ask for confirmation before writing. | Effect: Write | |
| log_hive_inspection Log a detailed beekeeping hive inspection. ALWAYS ask for confirmation before writing. | Effect: Write | |
| log_honey_harvest Log honey extracted and optionally add directly to stock inventory. ALWAYS ask for confirmation before writing. | Effect: Write | |
| log_manual_transaction Log a manual income, expense, or equity transaction. Supports confirm and idempotency validation. | Effect: Write | |
| log_meat Log a new meat processing batch and record the resulting cuts to freezer inventory. Requires farmId and apiKey authorization. | Effect: Write | |
| log_mileage Log a vehicle travel trip with automatic trip-date IRS rate calculations. Supports confirm and idempotency validation. | Effect: Write | |
| log_time Log labor time for farm work or tasks. The entry is always recorded for the user behind the API key. Supports confirm and idempotency valid… | Effect: Write | |
| log_varroa_treatment Record a mite treatment chemical or acid application. ALWAYS ask for confirmation before writing. | Effect: Write | |
| merge_bird_batches Consolidate multiple Live bird batches into a Target batch. Earliest hatch date across batches is inherited. Supports confirm and idempoten… | Effect: Write | |
| move_email Archive, move (INBOX/ARCHIVE/TRASH/SPAM) or mark read/unread Email Assistant messages, exactly like the Email Assistant buttons (updates Qu… | Effect: Write | |
| reply_to_ticket Add a reply message to an open support ticket. ALWAYS ask for confirmation before writing. | Effect: Write | |
| send_email Send an existing reply draft (from draft_email_reply) from the farm's Email Assistant mailbox. Only works if the farm OWNER turned on "Allo… | Effect: Write | |
| set_rentahatch_listing_active Set a vendor listingActive true/false (Live/Hidden). SuperAdmin only. confirm:true required. | Effect: Write | |
| start_signup Start a QuailOS signup from chat: returns a personal prefilled signup link for the farmer (name, email, optional farm name/state/phone/spec… | Effect: Write | |
| submit_wiki_article Submit a community wiki article proposal for admin moderation review. Supports confirm and idempotency validation. | Effect: Write | |
| unmerge_bird_batches Undo an active batch merge, restoring target and source batches to pre-merge states. Supports confirm and idempotency validation. | Effect: Write | |
| update_customer Update an existing customer in the CRM. Supports confirm and idempotency validation. | Effect: Write | |
| update_farm_note Update a Farm Note content and/or date. confirm:true. | Effect: Write | |
| update_inventory_product Update a General Inventory product by productId or sku: name, SKU, ASIN, barcode, category, prices, manufactured flag and BOM (bomComponent… | Effect: Write | |
| update_order_notes Appends a timestamped 'via AI' note by default | Effect: Write | |
| update_queen_status Update the live queenright and breeder metadata settings of a hive. ALWAYS ask for confirmation before writing. | Effect: Write | |
| update_rentahatch_payout_status Mark a payout_ledger row paid with paymentReference (Rent Admin Mark as Paid). SuperAdmin only. confirm:true. | Effect: Write | |
| update_rentahatch_waitlist_status Update a waitlist prospect status (pending|contacted|recruited|closed) or delete:true. SuperAdmin only. Mirrors Admin > Waitlist. | Effect: Write | |
| update_task Update properties of an existing task. Supports confirm and idempotency validation. | Effect: Write | |
| express_supplier_interest Show interest in a DIRECT_SHIP (or any Active) Supply Opportunity for this farm. Writes a Pending farmInterest and opens a support ticket (… | Effect: Read | |
| find_quail_pairings Perform a reverse genetic lookup to find all possible parent pairings (sire and dam) that can produce a targeted plumage color variety. | Effect: Read | |
| get_academy_course Get one published Academy course with modules/lessons metadata. Media (videoId, pdfUrl) is only returned for free-preview lessons or enroll… | Effect: Read | |
| get_beekeeping_apiary Retrieve active yards, hives, queen statuses, and varroa inspections. Requires farmId and apiKey authorization. | Effect: Read | |
| get_bird_batches Retrieve active and archived poultry census batches from the flock inventory. | Effect: Read | |
| get_calendar_events Retrieve calendar events for the farm including hatches, local events, rentals, and task due dates. Requires farmId and apiKey authorizatio… | Effect: Read | |
| get_customer_details Retrieve detailed profile of a specific customer in your CRM by email or name. Requires farmId and apiKey authorization. | Effect: Read | |
| get_egg_collections Retrieve daily egg production logs and collection counts. Requires farmId and apiKey authorization. | Effect: Read | |
| get_email Read one Email Assistant message as sanitized plain text, plus its conversation thread and any open AI drafts for that thread. Attachment m… | Effect: Read | |
| get_farm_note Get one Farm Note by noteId. | Effect: Read | |
| get_farm_times_article Get one Farm Times article by id or slug. Public read-only. | Effect: Read | |
| get_feature_requests List feature requests submitted by this farm. Requires farmId and apiKey authorization. | Effect: Read | |
| get_feed_inventory Retrieve active feed inventory, feed purchases, and feed mill logs. Requires farmId and apiKey authorization. | Effect: Read | |
| get_financial_pnl Retrieve summarized expenses, income, cash flow, and profit-and-loss details. Requires farmId and apiKey authorization. | Effect: Read | |
| get_hatches Retrieve incubation and hatch batches. Requires farmId and apiKey authorization. | Effect: Read | |
| get_library_item Get one Library item. URL omitted when farm tier < item.minTier (default Silver) with upgrade message. | Effect: Read | |
| get_meat_inventory Retrieve meat processing logs and cold storage/freezer inventory. Requires farmId and apiKey authorization. | Effect: Read | |
| get_mileage_logs Retrieve registered vehicle mileage logs for tax and expense auditing. | Effect: Read | |
| get_npip_stock_codes Resolve biological poultry and game-bird varieties to regulatory federal NPIP stock numbers. | Effect: Read | |
| get_order_feedback List customer feedback left on online orders (the Online Orders > Feedback tab): hatch-rate reports with eggs set/hatched, star rating and … | Effect: Read | |
| get_orders Retrieve the farm's sales orders (manual, connected stores and incoming dropships), newest first. Returns { totalMatches, totalMatchesIsExa… | Effect: Read | |
| get_production_orders Retrieve manufacturing production orders for farm inventory. | Effect: Read | |
| get_public_farms Search the QuailOS public farm directory. Retrieve farm names, locations, specialties, and bios. | Effect: Read | |
| get_public_wiki_pages Search published public QuailOS poultry, game-bird, and hatchery guide articles and walkthroughs. | Effect: Read | |
| get_quailos_tv Get one QuailOS TV video by doc id or YouTube videoId. Non-approved hidden unless SuperAdmin. | Effect: Read | |
| get_rentahatch_vendor Get one Rent-a-Hatch vendor by farmId or slug. SuperAdmin only. payoutDetails.details is masked. | Effect: Read | |
| get_support_tickets List support tickets created by this farm. Requires farmId and apiKey authorization. | Effect: Read | |
| get_tasks Retrieve farm management tasks, newest due date first by default (tasks without a due date last). Filters: status (Pending | In Progress | … | Effect: Read | |
| get_ticket_thread Retrieve full reply history and messages thread of a support ticket. Requires farmId and apiKey authorization. | Effect: Read | |
| get_time_logs Retrieve registered worker time clocks and logged task labor hours. | Effect: Read | |
| get_transactions Retrieve manual general ledger expense, income, and equity transactions. | Effect: Read | |
| get_vendors_and_pos Retrieve purchase orders and vendor profiles. Requires farmId and apiKey authorization. | Effect: Read | |
| list_academy_courses List published QuailOS Academy courses (excludes Rent-a-Hatch category). Read-only. Includes price/freeForTiers hints. | Effect: Read | |
| list_emails List messages in this farm's QuailOS Email Assistant inbox (the mailbox the farm connected in Office > Email Assistant: Forwarding Bridge a… | Effect: Read | |
| list_farm_notes List Farm Notes for this farm (Office > Farm Notes). Newest first. | Effect: Read | |
| list_farm_times_articles List published Farm Times / community_news articles. Public read-only. Paginate with cursor. | Effect: Read | |
| list_farm_times_headlines List active The Farm Times headlines (system community news). Public read-only. Not farm timeclock logs. | Effect: Read | |
| list_library_items List QuailOS Library items. Per-item tier gate: if farm below minTier, metadata returned with locked:true and NO url, plus upgrade message. | Effect: Read | |
| list_my_academy_enrollments List this farm's Academy enrollments/progress (read-only). To enroll in a course, use enroll_academy_course. | Effect: Read | |
| list_my_supplier_shipments List this farm's Supply Opportunity shipments only (Financial Dashboard equivalent). Omits paymentDetails. Read-only. | Effect: Read | |
| list_quail_varieties List all registered Coturnix quail varieties with their display names, unique IDs, description, and exact genotype mappings. | Effect: Read | |
| list_quailos_tv List QuailOS TV videos. Default status=approved only (public). Read-only; no approve/reject. | Effect: Read | |
| list_rentahatch_bookings List rentals bookings. SuperAdmin only. Customer email/phone omitted unless includeContact:true (PII access audited). | Effect: Read | |
| list_rentahatch_payouts List payout_ledger rows. SuperAdmin only. Masks payoutDetails.details by default. | Effect: Read | |
| list_rentahatch_vendors List Rent-a-Hatch vendors (farms with rentalSettings). SuperAdmin AI key only. Not purchase-order vendors (use get_vendors_and_pos for thos… | Effect: Read | |
| list_rentahatch_waitlist List rent_a_hatch_waitlist customer prospects (NOT vendor applications). SuperAdmin only. Contains emails — argument names only in mcp_logs. | Effect: Read | |
| list_supplier_opportunities List Active Supply Opportunities (what QuailOS/Undique is currently buying from member farms, e.g. quail wings Bulk-Supply). Public; no far… | Effect: Read | |
| list_vehicles Retrieve registered farm vehicles for mileage logging. Requires farmId and apiKey authorization. | Effect: Read | |
| ping Verify server connectivity, handshake responsiveness, and platform status. | Effect: Read | |
| plan_flock Calculate chicken/quail flock sizing, incubation guidelines, weekly feed, spaces, and costs for any of the 310 avian breeds. | Effect: Read | |
| predict_quail_cross Calculate offspring plumage color probability distributions and percentages when crossing a specific sire and dam variety. | Effect: Read | |
| update_supplier_shipment_tracking Add carrier/tracking to this farm's Draft supplier shipment and mark it Shipped (same as SupplierPage). Opens a support ticket. Set confirm… | Effect: Read |