Skip to main content
Glama

Record treatment

farmbrite_create_treatment

WRITE: record a treatment (vaccine, dewormer, spray, fertilizer...) for an animal, livestock group, field or crop planting. Adds a record each time. POST /{animals|livestock_groups|plots|crops}/{id}/treatments.

Input Schema

NameRequiredDescriptionDefault
costNo
dateNo
typeYesTreatment type.
amountNoAmount given (a number, or text with its unit such as '5 ml').
parentYes
productNo
parent_idYesAnimal, livestock group, field (plot) or crop planting id (a Farmbrite id string).
technicianNo
descriptionNo
retreat_dateNo
withdrawal_dateNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already cover the safety profile (readOnlyHint=false, idempotentHint=false, openWorldHint=true, destructiveHint=false), and the description only reinforces the non-idempotency with 'Adds a record each time' plus an endpoint path. It says nothing about required permissions, which fields the API rejects, or what the response contains beyond a created id.

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?

Two tight sentences plus an endpoint path, with the WRITE marker and target scope front-loaded. No filler; the endpoint line is borderline but adds precision about resource hierarchy.

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

Completeness2/5

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

For an 11-parameter mutation with no output schema and sparse schema descriptions, the definition leaves too much unstated: which fields are optional vs required in practice, what withdrawal_date/retreat_date mean for food safety, and what comes back on success.

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

Parameters2/5

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

With 11 parameters and only 27% schema description coverage, the description must carry the load, yet it only clarifies the 'parent' enum (animal/livestock group/field/crop planting) and gives examples for the treatment type. Nine parameters — notably withdrawal_date, retreat_date, cost, amount and technician — go unexplained in both schema and description.

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 ('record a treatment') with concrete examples of treatment kinds and enumerates all four valid target entity types, then gives the exact endpoint shape. An agent can distinguish this from farmbrite_list_treatments or farmbrite_create_note without opening any schema.

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

Usage Guidelines3/5

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

'Adds a record each time' implicitly warns that repeats create duplicates, which is helpful. But there is no explicit routing guidance — nothing says to use farmbrite_list_treatments to verify before writing, or how this differs from adjacent create tools for feedings, harvests or notes.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.