brapi-mcp-server

Brapi Find Images

brapi_find_images

Read-only

Filter images by observation unit, observation, study, descriptive ontology term, file name, or MIME type. Returns metadata only — use brapi_get_image to fetch bytes inline. When the upstream total exceeds loadLimit, the full result set is materialized as a dataframe — query it with brapi_dataframe_query (SQL).

Input Schema

TableJSON Schema

Name	Required	Description
`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.
`images`	No	Filter by imageDbIds.
`studies`	No	Filter by studyDbIds.
`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.
`mimeTypes`	No	Filter by MIME type — e.g. "image/jpeg", "image/png".
`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.
`observations`	No	Filter by observationDbIds.
`imageFileNames`	No	Filter by uploaded file name.
`observationUnits`	No	Filter by observationUnitDbIds.
`descriptiveOntologyTerms`	No	Filter by ontology tags (e.g. "CO_334:plot").

Output Schema

TableJSON Schema

Name	Required	Description
`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	Image metadata 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.

Schema Changelog

Changes observed during successful MCP inspections.

First observedSep 19, 2026

TDQS

A4.4/5.0

Behavior4/5

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

Annotations already cover readOnlyHint and openWorldHint, so the safety profile is known. The description adds genuinely non-obvious behavior: results are metadata-only, and exceeding loadLimit materializes the full result set as a dataframe in the session. This goes beyond what annotations convey and contradicts nothing.

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?

Three sentences, each earning its place: filter dimensions, metadata-only scope plus the byte-fetching alternative, and the loadLimit/dataframe overflow behavior. Core filtering purpose is front-loaded before edge-case routing; no filler or redundancy.

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?

With an output schema present and 100% parameter coverage, the description needn't restate return values or params. It covers the decisions an agent faces: when to call this vs brapi_get_image and what happens when results exceed loadLimit. Minor gap: no statement of how multiple filters compose (AND vs OR), which is a reasonable gap given the schema covers param mechanics.

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 the schema already documents all 10 parameters, including the loadLimit dataframe fallback and extraFilters precedence. The description restates filter dimensions but adds little nuance beyond the schema, so the baseline 3 applies.

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 an explicit verb+resource ('Filter images') and enumerates six filter dimensions (observation unit, observation, study, ontology term, file name, MIME type). It distinguishes itself from brapi_get_image by explicitly limiting its scope to metadata, and the resource focus differentiates it from sibling brapi_find_* tools.

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

Usage Guidelines5/5

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

Gives two explicit routing rules with conditions: 'Returns metadata only — use brapi_get_image to fetch bytes inline' establishes a clear when-not-to-use boundary, and 'query it with brapi_dataframe_query (SQL)' routes the overflow case. The agent knows exactly when to leave this tool for an alternative.

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.