brapi-mcp-server

Brapi Get Study

brapi_get_study

Read-onlyIdempotent

Fetch 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.

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
`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	Resolved trial record (when the study has a trialDbId and the FK lookup succeeded).
`program`	No	Resolved program record (when the study or parent trial identifies a program and the FK lookup succeeded).
`location`	No	Resolved location record (when the study has a locationDbId and the FK lookup succeeded).
`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.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 19, 2026

changedOutput schema / properties / error / properties / data / properties / reason / description

Previous value: -"Machine-readable failure mode. Declared by this tool: `unknown_alias`: No connection is registered under the requested alias, and the server has no base URL configured for it to connect on first use. `auth_token_exchange_failed`: Connecting the alias on first use, the SGN or OAuth token exchange against the BrAPI /token endpoint failed. `auth_no_access_token`: Connecting the alias on first use, the token endpoint answered without returning an access token. `capability_discovery_unavailable`: Neither /serverinfo nor /calls listed any call, and at least one of them timed out, was unreachable, or answered 429 or a 5xx other than 501, so nothing was cached. `upstream_unauthorized`: The BrAPI server answered HTTP 401: it requires credentials, or rejected the ones sent. `upstream_forbidden`: The BrAPI server answered HTTP 403: the credentials sent, or their absence, lack access. `alias_base_url_invalid`: The base URL configured on the server for this alias is not an absolute http(s) URL, or carries credentials. `private_address_blocked`: The base URL configured for this alias, or its token URL, is on a private or reserved address this server may not reach. `study_not_found`: Upstream returned no study record for the requested DbId. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `upstream_rate_limited`: An uncaught BrAPI data request exhausted retries after HTTP 429. `unknown_alias`: No connection is registered under the requested alias, and the server has no base URL configured for it to connect on first use. `auth_token_exchange_failed`: Connecting the alias on first use, the SGN or OAuth token exchange against the BrAPI /token endpoint failed. `auth_no_access_token`: Connecting the alias on first use, the token endpoint answered without returning an access token. `capability_discovery_unavailable`: Neither /serverinfo nor /calls listed any call, and at least one of them timed out, was unreachable, or answered 429 or a 5xx other than 501, so nothing was cached. `upstream_unauthorized`: The BrAPI server answered HTTP 401: it requires credentials, or rejected the ones sent. `upstream_forbidden`: The BrAPI server answered HTTP 403: the credentials sent, or their absence, lack access. `alias_base_url_invalid`: The base URL configured on the server for this alias is not an absolute http(s) URL, or carries credentials. `private_address_blocked`: The base URL configured for this alias, or its token URL, is on a private or reserved address this server may not reach. `study_not_found`: Upstream returned no study record for the requested DbId. Other values are possible when a failure originates below the handler."

changedOutput schema / properties / error / properties / data / properties / reason / examples

Previous value: -[
-  "unknown_alias",
-  "auth_token_exchange_failed",
-  "auth_no_access_token",
-  "capability_discovery_unavailable",
-  "upstream_unauthorized",
-  "upstream_forbidden",
-  "alias_base_url_invalid",
-  "private_address_blocked",
-  "study_not_found"
-]New value: +[
+  "upstream_rate_limited",
+  "unknown_alias",
+  "auth_token_exchange_failed",
+  "auth_no_access_token",
+  "capability_discovery_unavailable",
+  "upstream_unauthorized",
+  "upstream_forbidden",
+  "alias_base_url_invalid",
+  "private_address_blocked",
+  "study_not_found"
+]

Changed1 schema field changedOct 18, 2026

changedOutput schema / properties / program / description

Previous value: -"Resolved program record (when the study has a programDbId and the FK lookup succeeded)."New value: +"Resolved program record (when the study or parent trial identifies a program and the FK lookup succeeded)."

Changed6 schema fields changedOct 18, 2026

changedInput schema / properties / alias / description

Previous value: -"Connection 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."New value: +"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."

removedInput schema / properties / studyDbId / minLength
```
Removed value: -1
```
addedInput schema / properties / studyDbId / pattern
```
Added value: +"\\S"
```

changedOutput schema / properties / alias / description

Previous value: -"Alias of the registered BrAPI connection the call used."New value: +"Connection alias the call used."

changedOutput schema / properties / error / properties / data / properties / reason / description

Previous value: -"Machine-readable failure mode. Declared by this tool: `unknown_alias`: No connection has been registered under the requested alias. `study_not_found`: Upstream returned no study record for the requested DbId. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `unknown_alias`: No connection is registered under the requested alias, and the server has no base URL configured for it to connect on first use. `auth_token_exchange_failed`: Connecting the alias on first use, the SGN or OAuth token exchange against the BrAPI /token endpoint failed. `auth_no_access_token`: Connecting the alias on first use, the token endpoint answered without returning an access token. `capability_discovery_unavailable`: Neither /serverinfo nor /calls listed any call, and at least one of them timed out, was unreachable, or answered 429 or a 5xx other than 501, so nothing was cached. `upstream_unauthorized`: The BrAPI server answered HTTP 401: it requires credentials, or rejected the ones sent. `upstream_forbidden`: The BrAPI server answered HTTP 403: the credentials sent, or their absence, lack access. `alias_base_url_invalid`: The base URL configured on the server for this alias is not an absolute http(s) URL, or carries credentials. `private_address_blocked`: The base URL configured for this alias, or its token URL, is on a private or reserved address this server may not reach. `study_not_found`: Upstream returned no study record for the requested DbId. Other values are possible when a failure originates below the handler."

changedOutput schema / properties / error / properties / data / properties / reason / examples

Previous value: -[
-  "unknown_alias",
-  "study_not_found"
-]New value: +[
+  "unknown_alias",
+  "auth_token_exchange_failed",
+  "auth_no_access_token",
+  "capability_discovery_unavailable",
+  "upstream_unauthorized",
+  "upstream_forbidden",
+  "alias_base_url_invalid",
+  "private_address_blocked",
+  "study_not_found"
+]

First observedSep 19, 2026

TDQS

A3.8/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 genuinely new behavior: related lookups resolve only 'where those lookups succeed' (partial-failure semantics) and the counts are described as 'cheap', a cost hint. It does not contradict the 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?

Two sentences, zero filler, with the primary action front-loaded and the secondary return-value context trailing. Every clause carries information.

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?

An output schema exists, so return format need not be explained, and annotations plus full schema coverage carry the rest. The description supplies the partial-resolution caveat and the drill-down framing, leaving only the connection/alias lifecycle to the schema. Complete enough for an agent to call it correctly.

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 coverage is 100%, so studyDbId and alias are already fully documented, including the alias reuse rule. The description's 'by DbId' merely restates the required parameter and says nothing about alias, so baseline 3 is appropriate.

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?

States a specific verb and resource ('Fetch a single study by DbId') and scopes it to one record, which implicitly separates it from the plural sibling brapi_find_studies. It also names the resolved sub-records (program, trial, location). It stops short of explicitly naming the sibling it replaces, so a 4 rather than a 5.

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 phrase 'drill-down signals' hints at an exploratory use case, and 'single study by DbId' implies you already know the identifier, but there is no statement of when to prefer this over brapi_find_studies or any exclusions/prerequisites. Usage is implied rather than specified.

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

All brapi-mcp-server tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.