Brapi Find Germplasm
brapi_find_germplasmFind germplasm by name, synonym, accession number, PUI, crop, or free-text query. Matches across registered synonyms. When the upstream total exceeds loadLimit, the full result set is materialized as a dataframe — query it with brapi_dataframe_query (SQL) instead of paging row-by-row.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Free-text query. Applied client-side as a substring match on returned rows (germplasmName, accessionNumber, defaultDisplayName, registered synonyms) — no BrAPI server reliably supports a server-side free-text filter, so combine with `crops` / `genus` / etc. to narrow the upstream pull first. | |
| alias | No | 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. | |
| crops | No | Filter by common crop names. | |
| genus | No | Botanical genus. | |
| names | No | Filter by germplasm display names. | |
| species | No | Botanical species. | |
| synonyms | No | Match registered synonyms. | |
| loadLimit | No | Cap on rows returned inline. Omit for the deployment default. Rows beyond the cap land in a dataframe; query with brapi_dataframe_query (SQL) instead of paging row-by-row. | |
| collections | No | Filter by germplasm collection names. | |
| extraFilters | No | Extra BrAPI filters forwarded verbatim. Valid keys vary by endpoint; brapi_describe_filters enumerates them. Named params on this tool take precedence on conflict. | |
| germplasmPUIs | No | Persistent unique identifiers. | |
| germplasmDbIds | No | Filter by DbIds. | |
| accessionNumbers | No | Filter by accession numbers (gene-bank catalog codes). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Alias of the registered BrAPI connection the call used. | |
| error | No | Present when the call failed. Absent on success. | |
| notice | No | Guidance when no rows were returned — how to broaden filters or retry. | |
| hasMore | No | True when more rows exist beyond the returned set. | |
| results | No | Germplasm rows returned in-context (up to loadLimit). | |
| warnings | No | Advisory messages (filter overrides, partial data, capability gaps). | |
| dataframe | No | Dataframe handle when the full result set was materialized as a dataframe. Query it with brapi_dataframe_query (SQL). | |
| totalCount | No | Total rows reported by the server. | |
| distributions | No | Value frequency per field across the full result set. | |
| returnedCount | No | Length of results[]. | |
| appliedFilters | No | The final filter map sent to the server (named + extraFilters). | |
| refinementHint | No | Suggested next-step query refinement when the result set is large. |