Skip to main content
Glama
lingcSun

mcp-bw-adt-api

by lingcSun
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

bw_reporting_preview

Preview BICS query results by specifying provider and row characteristics, with optional columns and pagination controls. Returns flat rows inline or writes full query view to file.

Instructions

Convenience BICS preview: GET metadata → put named characteristics on ROWS (optional COLUMNS) → POST refresh. Same as Eclipse Dashboard Preview for ADSO / characteristic / Composite Provider. Inline response is flatRows (paginated); set outputPath for the full QueryView.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rowsYesCharacteristic names for the ROWS axis (e.g. ["0PROFIT_CTR", "0COMP_CODE"]).
toRowNoResult-set end row inclusive (default ~1000 on server).
columnsNoOptional characteristic names for COLUMNS. Omit to keep the key-figure structure on COLUMNS.
fromRowNoResult-set start row (default 0).
providerYesProvider technical name, with or without ! (e.g. ZL_FID09).
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.3/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses the multi-step behavior (GET metadata → POST refresh), the inline response format (flatRows, paginated), and the outputPath behavior (full result written, small summary envelope returned, skip inline pagination). It also explains the file format nuance for XML vs parsed JSON. This is substantial behavioral disclosure beyond the schema.

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?

The description is dense but well-structured: the core workflow is front-loaded in the first sentence, followed by response format and outputPath guidance. The outputPath paragraph is long and covers multiple nuances (JSON vs XML, other *_get tools, large responses), which is valuable but slightly verbose. Every sentence earns its place, though the outputPath explanation could be tightened.

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?

For a 6-parameter tool with no output schema and no annotations, the description covers the essential workflow, response format, pagination, and outputPath behavior. It doesn't explicitly describe the default row limit or the exact shape of the inline response beyond 'flatRows (paginated)', but the schema documents fromRow/toRow defaults. The description is complete enough for an agent to call the tool correctly, with minor gaps around error cases and the exact summary envelope fields.

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. The description adds meaning beyond the schema by explaining the overall flow (rows/columns placement, refresh) and by clarifying the outputPath behavior (summary envelope, file format, skip pagination). It doesn't add per-parameter syntax details beyond the schema, but the schema already covers those. The added context about outputPath and flatRows justifies a 4.

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 states a specific verb ('preview'), the resource (BICS query), and the workflow (GET metadata → put characteristics on ROWS/COLUMNS → POST refresh). It also names the analogous Eclipse Dashboard Preview and distinguishes it from the sibling bw_reporting_initial_view / bw_reporting_update_view by describing the convenience flow. This is a clear, specific purpose.

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 explains the intended usage pattern (convenience preview, same as Eclipse Dashboard Preview) and gives a clear when-to-use signal for outputPath ('Use outputPath for large responses'). It does not explicitly say when NOT to use this tool versus bw_reporting_initial_view or bw_reporting_update_view, but the workflow description implies it is the preview variant. Slight gap in explicit exclusions.

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

Deploy Server

Other Tools