Skip to main content
Glama
lingcSun

mcp-bw-adt-api

by lingcSun

bw_search_objects

Filter SAP BW objects by type, date range, name, or description to retrieve matching object URIs and metadata.

Instructions

Advanced BW object search with filters (type, dates, name/description). Returns a list of { objectName, objectType, title, uri, ... }. Use outputPath for large result sets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
objectTypeNo
outputPathNoIf provided, the full result is written to this path (under the workdir) and the tool returns only a small summary envelope { ok, outputPath, bytes, summary }. Objects/arrays are written as JSON; ONLY the bw_*_get_xml family writes the raw XML string as plain text (that file is directly reusable as xmlPath in a later save call). Other *_get tools (e.g. bw_dtp_get, bw_trfn_get) write the PARSED XML-to-JSON tree, not raw XML — use the matching bw_*_get_xml tool when you need the raw XML string. Use outputPath for large responses (XML, table data, logs, dataflow graphs). When set, tools skip inline pagination/projection so the file contains the complete payload.
searchTermYesSearch term, may include wildcards like 0ASSET*.
changedOnToNoISO 8601 date.
createdOnToNoISO 8601 date.
searchInNameNo
changedOnFromNoISO 8601 date.
createdOnFromNoISO 8601 date.
searchInDescriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are provided, so the description carries the transparency burden. The verb 'search' and 'Returns a list' imply a read-only operation, and the outputPath note signals writing behavior for large results. However, it does not explicitly state non-mutation, default pagination/limits, or what happens if the result set is large without outputPath.

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?

The description is three short sentences with the core purpose, return shape, and key usage tip front-loaded. Every sentence contributes information, and there is no redundant restatement of the tool name or schema.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no annotations and no output schema, the description covers the essential invocation path: required searchTerm, filters, result shape, and outputPath for large sets. It leaves gaps around default result-size behavior, how multiple filters combine, and an explicit read-only guarantee, which an agent may need to call the tool confidently.

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?

The schema already documents most parameters: searchTerm wildcards, ISO date fields, objectType enum, and a detailed outputPath description. The description adds a high-level grouping of filters (type, dates, name/description), which helps orient an agent but does not add significant per-parameter semantics beyond the schema.

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?

The description clearly identifies the tool as an 'Advanced BW object search' with named filters (type, dates, name/description), and gives a concrete return shape of object metadata fields. This is specific enough to distinguish it from the many sibling detail/retrieval tools, none of which are object-search tools.

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

Usage Guidelines3/5

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

The use case is implied: find BW objects by search term with optional filters. The only explicit guidance is 'Use outputPath for large result sets,' which addresses response-size handling rather than when to choose this tool over an alternative. No sibling alternatives or exclusion conditions are mentioned.

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