Skip to main content
Glama
c41m4n

farmos-mcp

by c41m4n

query_records

Read-only

Query a single farmOS record bundle with filters, sorting, field selection, and pagination to retrieve the assets, logs, plans, or terms you need.

Instructions

Query one bundle of records with filtering, sorting and paging. This is the general read tool; search_assets, list_logs and list_plans cover the common cases.

Input Schema

NameRequiredDescriptionDefault
sortNoComma-separated fields, '-' prefix for descending, e.g. '-timestamp'
limitNoRecords per page (max 50), or the total cap when all_pages is true
bundleYesBundle, e.g. 'plant' for assets, 'harvest' for logs, 'plant_type' for terms
fieldsNoOnly return these attributes/relationships
offsetNoSkip this many records (ignored when all_pages is true)
filtersNoField path -> value (equality), list (IN), or {'operator': '>=', 'value': 123}. Operators: =, <>, >, >=, <, <=, STARTS_WITH, CONTAINS, ENDS_WITH, IN, NOT IN, BETWEEN, NOT BETWEEN, IS NULL, IS NOT NULL. Relationship paths work, e.g. {'asset.id': '<uuid>'}. Log 'timestamp' filters take epoch seconds.
includeNoRelationships to embed, comma-separated, e.g. 'asset,location'
all_pagesNoFollow pagination until 'limit' records are collected
entity_typeYesEntity type: asset, log, plan, quantity, taxonomy_term, ...

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds one real behavioral constraint — it queries a single bundle per call — but says nothing about result volume, response shape, or performance characteristics. With annotations carrying the safety profile, this is adequate but thin.

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

Conciseness5/5

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

Two short sentences, zero waste, with the primary identification front-loaded and the sibling routing immediately after. Appropriately sized for a tool whose schema does the heavy lifting.

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

Completeness4/5

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

With an output schema present, full parameter documentation and read-only annotations, the description covers the remaining gap — role and routing. It could briefly note the single-entity/bundle constraint more explicitly, but nothing essential to correct invocation is missing.

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 100% and the parameters are richly documented in-schema (sort syntax, filter operators, pagination semantics, limit max). The description adds no parameter-level detail beyond what the schema already provides, so baseline 3 applies.

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

Purpose5/5

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

States a specific verb (query) and resource (records) plus the supported operations (filtering, sorting, paging), and explicitly positions itself as the general read tool against named siblings search_assets, list_logs and list_plans. An agent can distinguish it from every sibling without opening a schema.

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?

"This is the general read tool; search_assets, list_logs and list_plans cover the common cases" gives clear routing guidance toward the specialized siblings. It stops short of explicit when-not-to-use conditions, but the fallback/general-case role is unambiguous.

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