Skip to main content
Glama
lingcSun

mcp-bw-adt-api

by lingcSun
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

bw_trfn_details

Fetch parsed details of a BW transformation by ID, with an option to write the full JSON result to a file for large responses.

Instructions

Get parsed transformation details. Prefer outputPath.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
versionNoVersion: m=active, a=modified, d=revised.
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/5.0
Behavior4/5

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

The description discloses important behavioral traits: when outputPath is set, the tool writes the full result to a file and returns only a summary envelope; it skips inline pagination/projection; and it clarifies the output format for different tool families. This goes beyond the schema and provides useful context for the agent.

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 a bit long but front-loaded with the core purpose ('Get parsed transformation details. Prefer outputPath.'). The additional detail about outputPath behavior is dense but relevant. It could be slightly more concise, but every sentence adds value.

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?

Given the tool's complexity and the rich outputPath behavior, the description covers the key aspects an agent needs: what the tool does, when to use outputPath, and what the return format will be. It doesn't describe the default return format when outputPath is not set, which is a minor gap, but overall it's fairly complete.

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?

The schema already documents the version enum and outputPath semantics in detail. The description reinforces the outputPath behavior and adds the note about the summary envelope and file format. With 67% schema coverage, the description compensates for the undocumented 'id' parameter by implying it's the transformation identifier, though it doesn't explicitly state that.

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 states a specific verb and resource: 'Get parsed transformation details.' This clearly identifies the tool's function. However, it doesn't explicitly distinguish it from sibling tools like bw_trfn_get_xml or bw_trfn_versions, though the outputPath note partially clarifies the difference.

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 gives clear guidance on when to use outputPath: 'Use outputPath for large responses (XML, table data, logs, dataflow graphs).' It also explains the difference between the bw_*_get_xml family and other *_get tools, which helps an agent choose the right tool. It doesn't explicitly say when not to use this tool, but the context is fairly clear.

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