Skip to main content
Glama
Ranch.Bot MCP Server

Ranch.Bot MCP Server

Official
by RanchBot

List records

list_records
Read-only

Retrieve farm event records for animals or groups, or farm-wide, filtered by animal, group, type, or date range to view bounded histories.

Instructions

List records (events applied to animals or groups, e.g. feed/health/movement) on the farm. Without a target or time bound this is the ordinary farm-wide list. With an animal_id, group_id and/or applied_from/applied_before it becomes a bounded history read (default 50, max 200). Scoped credentials: an animal_id filter also needs read:animals, a group_id filter also needs read:groups, and include_group_context needs both.

Input Schema

NameRequiredDescriptionDefault
skipNo
takeNo
typeNo
farm_idNo
group_idNo
animal_idNo
applied_fromNo
applied_beforeNo
include_group_contextNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv0.2.0
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / animal_id
      Added value: +{
      +  "format": "uuid",
      +  "type": "string"
      +}
    • addedInput schema / properties / applied_before
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / applied_from
      Added value: +{
      +  "type": "string"
      +}
    • removedInput schema / properties / farm_id / description
      Removed value: -"The ID of the farm (optional if a default is set)."
    • addedInput schema / properties / group_id
      Added value: +{
      +  "format": "uuid",
      +  "type": "string"
      +}
    • addedInput schema / properties / include_group_context
      Added value: +{
      +  "type": "boolean"
      +}
    • removedInput schema / properties / skip / description
      Removed value: -"Records to skip (pagination)."
    • removedInput schema / properties / take / description
      Removed value: -"Max records to return."
    • removedInput schema / properties / type / description
      Removed value: -"Filter by record type."
    • removedInput schema / properties / type / enum
      Removed value: -[
      -  "FEED",
      -  "GENETIC",
      -  "HEALTH",
      -  "MOVEMENT",
      -  "OTHER"
      -]
  2. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint=true, so the description carries most of the burden and delivers real value: result-size behaviour (default 50, max 200) and scoped-credential requirements (read:animals for animal_id, read:groups for group_id, both for include_group_context). It does not describe ordering, cursor/skip behaviour, or the return shape, which are still open.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, purpose and default behaviour front-loaded, then the mode switch, then the credential constraints. Dense and free of filler, though the third sentence packs three separate auth conditions into one long clause.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter, zero-required, read-only list tool with no output schema, the description covers purpose, bounding modes, page size, and auth scoping, but leaves skip/take/type/farm_id semantics and the response shape entirely unexplained. Adequate for a simple list endpoint, but noticeably incomplete given how many parameters exist.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 9 parameters, so the description must compensate and only partly does: it explains animal_id, group_id, applied_from/applied_before, include_group_context, and indirectly the take limit (default 50, max 200). skip, take (by name), type, and farm_id get no semantic explanation anywhere, leaving several parameters undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb (list) and resource (records), with a parenthetical that defines what a record actually is (events applied to animals or groups, e.g. feed/health/movement), and it distinguishes two reading modes: an ordinary farm-wide list versus a bounded history read. The only gap is that it never names a sibling (get_record, create_record, list_traceability_events) to route the agent, so differentiation is implicit rather than explicit.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states the condition that changes behaviour: with no target or time bound it is the ordinary farm-wide list, and with animal_id, group_id and/or applied_from/applied_before it becomes a bounded history read. That is actionable context, though it stops short of naming alternative tools for overlapping cases (e.g. traceability events).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools