Skip to main content
Glama
lingcSun

mcp-bw-adt-api

by lingcSun
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

bw_infoobject_get

Retrieve SAP BW InfoObject details, including metadata, to inspect data foundation or verify configuration. Use outputPath to save complete results to a file.

Instructions

Get InfoObject details including metadata. Prefer outputPath.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
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

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure, but it only says 'Get InfoObject details' and 'Prefer outputPath.' It does not explain return behavior, side effects, permissions, or what happens when outputPath is omitted versus set; the richer outputPath behavior is deferred to the schema rather than the description.

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 two short sentences with no filler: the purpose statement is front-loaded and 'Prefer outputPath' is a useful directive. It is concise, though 'Prefer outputPath' is slightly abrupt without immediate rationale.

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?

For a simple getter with two parameters, the description gives the core purpose and a directive to use outputPath, but it does not describe the response shape when outputPath is not set, what 'metadata' includes, or any caveats. The schema's outputPath documentation fills some gaps, but no output schema exists and annotations are absent, so the description alone is only minimally adequate.

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 description coverage is 50%: outputPath is thoroughly documented in the schema, but the required 'name' parameter has no description. The tool description partially compensates by implying 'name' is the InfoObject identifier, and 'Prefer outputPath' adds invocation guidance, but it does not fully clarify the expected format or meaning of 'name.'

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

Purpose4/5

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

The description names a concrete action and resource: 'Get InfoObject details including metadata.' It clearly identifies the tool as a detail-retrieval operation for an InfoObject, and the resource type distinguishes it from sibling details tools for other object types, though it does not explicitly differentiate from any sibling.

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

Usage Guidelines2/5

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

'Prefer outputPath' is a parameter-usage recommendation, not guidance on when to choose this tool over alternatives. There is no mention of when this tool is appropriate compared to sibling validation tools or other get/detail tools, so an agent has no explicit routing guidance.

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