Brapi Connect
brapi_connectOpen a connection to a BrAPI v2 server, authenticate, and return the full orientation envelope (server identity, capability profile, content summary). Required handshake before other BrAPI tools. Supports multiple concurrent connections via named aliases. Credentials can be configured server-side and omitted from this call. Built-in known servers (callable with no baseUrl or auth — public BrAPI v2 endpoints): bti-breedbase-demo, bti-cassava, bti-sweetpotato, t3-barley, t3-oat, t3-wheat. Operator-configured aliases on this deployment (credentials and/or baseUrl read from server env vars): default, cassava. Aliases are shortcuts only; any other BrAPI v2 server is reachable by passing baseUrl directly.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| auth | No | Auth payload. Omit to use credentials configured server-side for this alias (or no auth when none are configured). | |
| alias | No | Alias for this connection. Use distinct aliases to register multiple BrAPI servers in one session. | default |
| baseUrl | No | BrAPI v2 base URL (absolute URL) including any path prefix — e.g. https://test-server.brapi.org/brapi/v2. Omit to use the configured default for this alias. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| auth | No | Auth summary for the active connection. | |
| alias | No | Connection alias. | |
| error | No | Present when the call failed. Absent on success. | |
| notes | No | Server-specific quirks or degradation notes. | |
| server | No | Normalized server identity block. | |
| baseUrl | No | BrAPI v2 base URL for this connection. | |
| content | No | Content summary (crops + optional totals). | |
| dialect | No | Active dialect adapter — translates outbound filters and declares known-dead routes for this server. | |
| fetchedAt | No | ISO 8601 timestamp of when this envelope was composed. | |
| attribution | No | Attribution metadata for built-in known-server connections. Absent for custom (env-only) connections. | |
| capabilities | No | Capability profile derived from /serverinfo. |