Skip to main content
Glama

Brapi Raw Get

brapi_raw_get
Read-only

Passthrough to BrAPI GET /{path} without foreign-key resolution. List results (result array or result.data) return a leading preview within loadLimit and a 24,000-byte budget on each serialized row representation; an oversized first row returns no inline rows. Omitted fetched rows remain in a dataframe readable with brapi_dataframe_describe and brapi_dataframe_query. Explicit params.page/pageSize fetches only that upstream page, staging it if trimmed. Non-list results and envelope siblings are preserved. Emits a suggestion when a curated tool covers the endpoint.

Input Schema

NameRequiredDescriptionDefault
pathYesEndpoint path — e.g. "/samples", "/methods". Leading "/" is optional.
aliasNoConnection 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.
paramsNoQuery parameters to append. Arrays are repeated per BrAPI convention.
loadLimitNoCap 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.

Output Schema

NameRequiredDescriptionDefault
capNoEffective loadLimit row ceiling, even when the byte budget binds first.
urlNoFully resolved URL that was fetched (baseUrl + path + query string).
pathNoNormalized path (leading `/` preserved) that was appended to the baseUrl.
aliasNoConnection alias the call used.
errorNoPresent when the call failed. Absent on success.
shownNoActual list rows returned inline.
noticeNoWhen a dataframe was staged, its name and the tools that read it.
resultNoRaw BrAPI `result` value — whatever shape the endpoint returns.
metadataNoBrAPI envelope metadata (pagination and any additional upstream fields).
warningsNoAdvisory messages — present when the dataframe walk stopped before the upstream total.
dataframeNoEvery fetched row of a list result, staged when the inline preview omits rows. Explicit paging stages only the requested page.
truncatedNoTrue when the inline list leaves fetched or matching rows out.
suggestionNoEmitted when a curated goal-shaped tool covers this endpoint, or takes the IDs it lists.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • 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. `cross_origin_path`: path argument was a full URL instead of a relative BrAPI route. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `upstream_not_found`: An uncaught BrAPI data request answered HTTP 404. `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. `cross_origin_path`: path argument was a full URL instead of a relative BrAPI route. 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",
      -  "cross_origin_path"
      -]New value: +[
      +  "upstream_not_found",
      +  "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",
      +  "cross_origin_path"
      +]
  2. Changed9 schema fields changed
    • addedOutput schema / properties / cap
      Added value: +{
      +  "description": "Effective loadLimit row ceiling, even when the byte budget binds first.",
      +  "exclusiveMinimum": 0,
      +  "maximum": 9007199254740991,
      +  "type": "integer"
      +}
    • changedOutput schema / properties / dataframe / description
      Previous value: -"The pages of a list-shaped result, staged when the upstream advertised more rows than `loadLimit`. The inline `result` is unchanged."New value: +"Every fetched row of a list result, staged when the inline preview omits rows. Explicit paging stages only the requested page."
    • changedOutput schema / properties / metadata / properties / pagination / properties / currentPage / description
      Previous value: -"0-indexed page number the server returned."New value: +"0-indexed page number, when reported."
    • changedOutput schema / properties / metadata / properties / pagination / properties / pageSize / description
      Previous value: -"Rows per page."New value: +"Rows per page, when reported."
    • changedOutput schema / properties / metadata / properties / pagination / properties / totalCount / description
      Previous value: -"Total rows matching the query across all pages."New value: +"Total matching rows, when reported."
    • changedOutput schema / properties / metadata / properties / pagination / properties / totalPages / description
      Previous value: -"Total pages at the current pageSize."New value: +"Total pages, when reported."
    • removedOutput schema / properties / metadata / properties / pagination / required
      Removed value: -[
      -  "currentPage",
      -  "pageSize",
      -  "totalCount",
      -  "totalPages"
      -]
    • addedOutput schema / properties / shown
      Added value: +{
      +  "description": "Actual list rows returned inline.",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / truncated
      Added value: +{
      +  "description": "True when the inline list leaves fetched or matching rows out.",
      +  "type": "boolean"
      +}
  3. Changed20 schema fields changed
    • 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 / path / minLength
      Removed value: -1
    • addedInput schema / properties / path / 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 / dataframe / description
      Previous value: -"Present when the upstream advertised more rows than `loadLimit` AND the result is a list shape. The inline `result` is unchanged; the dataframe carries the full union of pages — query with brapi_dataframe_query."New value: +"The pages of a list-shaped result, staged when the upstream advertised more rows than `loadLimit`. The inline `result` is unchanged."
    • changedOutput schema / properties / dataframe / properties / columnLegend / description
      Previous value: -"Maps a sanitized column name back to its original upstream key, for columns renamed to clear the SQL-safe-identifier gate (e.g. `end` → `end_`). Present only when a column was renamed — write SQL against the sanitized (left-hand) names."New value: +"Sanitized column name → original upstream key, present only when a column was renamed to be SQL-safe (e.g. `end` → `end_`). SQL uses the sanitized names."
    • changedOutput schema / properties / dataframe / properties / columns / description
      Previous value: -"Full column list of the dataframe."New value: +"Every column name."
    • changedOutput schema / properties / dataframe / properties / columns / items / description
      Previous value: -"Column name from the materialized rows."New value: +"Column name."
    • changedOutput schema / properties / dataframe / properties / createdAt / description
      Previous value: -"ISO 8601 timestamp the dataframe was created."New value: +"ISO 8601 creation time."
    • changedOutput schema / properties / dataframe / properties / expiresAt / description
      Previous value: -"ISO 8601 timestamp after which the dataframe metadata will be purged. Re-run the find_* tool to refresh, or copy results out before expiry."New value: +"ISO 8601 time the dataframe metadata is purged; copy rows out before, or re-run the producing tool."
    • changedOutput schema / properties / dataframe / properties / maxRows / description
      Previous value: -"Cap that was applied at create time, when truncation occurred."New value: +"Row cap that ended the pull, present only when that cap fired."
    • changedOutput schema / properties / dataframe / properties / rowCount / description
      Previous value: -"Number of rows materialized in the dataframe."New value: +"Rows in the dataframe."
    • changedOutput schema / properties / dataframe / properties / tableName / description
      Previous value: -"Dataframe name. Use with brapi_dataframe_describe (schema + provenance) and brapi_dataframe_query (SQL)."New value: +"Table name for brapi_dataframe_describe and brapi_dataframe_query."
    • changedOutput schema / properties / dataframe / properties / totalCount / description
      Previous value: -"Total rows reported by the upstream server (may exceed rowCount when truncated)."New value: +"Upstream-reported row total, when known; can exceed rowCount."
    • changedOutput schema / properties / dataframe / properties / truncated / description
      Previous value: -"True when the dataframe hit a row cap before exhausting upstream."New value: +"True when the dataframe holds less than the upstream reports: a cap, failed page, deadline, or short upstream ended the pull, or it was skipped. warnings says which. Absent otherwise."
    • 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. `cross_origin_path`: path argument was a full URL instead of a relative BrAPI route. 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. `cross_origin_path`: path argument was a full URL instead of a relative BrAPI route. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / error / properties / data / properties / reason / examples
      Previous value: -[
      -  "unknown_alias",
      -  "cross_origin_path"
      -]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",
      +  "cross_origin_path"
      +]
    • addedOutput schema / properties / notice
      Added value: +{
      +  "description": "When a dataframe was staged, its name and the tools that read it.",
      +  "type": "string"
      +}
    • changedOutput schema / properties / suggestion / description
      Previous value: -"Emitted when a curated goal-shaped tool covers this endpoint."New value: +"Emitted when a curated goal-shaped tool covers this endpoint, or takes the IDs it lists."
    • addedOutput schema / properties / warnings
      Added value: +{
      +  "description": "Advisory messages — present when the dataframe walk stopped before the upstream total.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  4. First observed

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint and openWorldHint, so the description carries the real behavioral load and does so thoroughly: leading preview within loadLimit, a 24,000-byte per-row serialization budget, the oversized-first-row edge case returning no inline rows, trimmed rows landing in a dataframe readable via brapi_dataframe_describe/brapi_dataframe_query, page/pageSize staging, and preservation of non-list results and envelope siblings.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the purpose sentence, then dense but purposeful detail about row budgets, dataframe fallback, paging, and suggestions. Every sentence carries information, though the byte-budget and staging sentences are packed tightly enough that they read more like spec text than guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/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 values need not be spelled out, and the description still supplies the operationally important parts: how much comes back inline, where the remainder goes, how to page, and how the tool behaves for non-list responses. Nothing an agent needs to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3, but the description adds real semantics beyond the schema — notably that explicit params.page/pageSize fetches only that upstream page and stages it if trimmed, and the inline-vs-dataframe consequence of loadLimit. Alias and params array handling remain schema-only, so it is above baseline but not exhaustive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (GET passthrough) on a specific resource (BrAPI /{path}) and adds a distinguishing scope qualifier: 'without foreign-key resolution'. That qualifier, plus the note that a curated tool may cover the endpoint, separates it from siblings like brapi_raw_search and the brapi_find_* / brapi_get_* family.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description makes the usage context clear (raw endpoint access when no curated tool applies) and even notes that a suggestion is emitted when a curated tool covers the endpoint. It stops short of an explicit directive such as 'prefer the curated tool when one exists', so it is clear context without a hard exclusion rule.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.