Skip to main content
Glama

Brapi Get Study

brapi_get_study
Read-onlyIdempotent

Fetch a single study by DbId with program, trial, and location fully resolved. Response includes cheap observation/observation-unit/variable counts as drill-down signals.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
aliasNoConnection alias registered via brapi_connect. Omit to read the connection registered under alias `default` — i.e. a prior brapi_connect call that did not specify an alias. Calls that used a non-default alias must pass that same alias here.
studyDbIdYesStudy identifier.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
aliasNoAlias of the registered BrAPI connection the call used.
errorNoPresent when the call failed. Absent on success.
studyNoCanonical study record as returned by `/studies/{id}`.
trialNoResolved trial record (when the study has a trialDbId and the FK lookup succeeded).
programNoResolved program record (when the study has a programDbId and the FK lookup succeeded).
locationNoResolved location record (when the study has a locationDbId and the FK lookup succeeded).
warningsNoAdvisory messages — failed FK lookups, missing counts.
variableCountNoTotal observation variables (traits) measured in this study. Omitted (with a warning) when the upstream server cannot scope the count to the study — never reported as the server-wide total.
observationCountNoTotal observations recorded against this study. Omitted (with a warning) when the upstream server cannot scope the count to the study — never reported as the server-wide total.
observationUnitCountNoTotal observation units (plots, plants, samples) in this study.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description adds value by disclosing that the response fully resolves program, trial, and location, and includes cheap observation/observation-unit/variable counts as drill-down signals—useful behavioral context beyond the annotations. No contradiction with annotations.

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?

The description is two sentences with zero redundancy. It front-loads the primary action and key identifier, then adds the distinguishing resolved-fields and count-signal details. Every word earns its place.

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

Completeness5/5

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

An output schema exists (has_output_schema: true), so return value details are covered elsewhere. Annotations cover safety. The description covers the lookup key, resolved entities, and count signals—everything an agent needs to decide to use this tool and call it correctly. No material gaps remain.

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% for both parameters, with alias and studyDbId already well documented. The description adds minimal parameter-specific meaning beyond confirming studyDbId is the lookup key and that related entities are resolved. Since the schema carries the full parameter semantics, a baseline of 3 is appropriate.

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?

The description states a specific verb (Fetch), a specific resource (a single study), and the key identifier (DbId). It also mentions what is resolved (program, trial, location) and the count signals, which clearly distinguishes it from search-like siblings such as brapi_find_studies. The purpose is unambiguous and immediately actionable.

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?

The description implies usage for a known study ID ('by DbId') but does not explicitly contrast with alternatives like brapi_find_studies or brapi_find_observations. It does not state when not to use it, leaving the agent to infer from the name and schema that this is a direct lookup tool rather than a search.

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.