Brapi Server Info
brapi_server_infoReturn the full orientation envelope for a registered BrAPI connection — server identity, capabilities, content counts, and notes. Re-running refreshes the cached capability scan; pass an alias to read a non-default connection.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Connection alias. 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. | |
| forceRefresh | No | Bypass the cached capability profile and refetch from the server. |
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. |