Brapi Get Study
brapi_get_studyFetch a single study by DbId with its program, trial, and location records resolved where those lookups succeed. Response includes cheap observation/observation-unit/variable counts as drill-down signals.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"studyDbId": "<studyDbId>"
},
"name": "brapi_get_study"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Connection alias. Omit to use alias `default`. An alias registered via brapi_connect works, and so does one the server has a URL configured for (a built-in alias, an operator-configured alias, or `default` on a deployment with a default server), which connects on first use. Calls that used a non-default alias must pass that same alias here. | |
| studyDbId | Yes | Study identifier. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Connection alias the call used. | |
| error | No | Present when the call failed. Absent on success. | |
| study | No | Canonical study record as returned by `/studies/{id}`. | |
| trial | No | Trial the study names; omitted with a warning when not resolved. | |
| program | No | Program the study or parent trial names; omitted with a warning when not resolved. | |
| location | No | Location the study names; omitted with a warning when not resolved. | |
| warnings | No | Advisory messages — failed FK lookups, missing counts. | |
| variableCount | No | Total 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. | |
| observationCount | No | Total 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. | |
| observationUnitCount | No | Total observation units (plots, plants, samples) in this study. |