Skip to main content
Glama
lingcSun

mcp-bw-adt-api

by lingcSun

bw_adso_get_xml

Get the raw ADSO XML needed for PUT updates. Use outputPath to write the full XML to disk, avoiding large inline responses and enabling reuse in later save/activate operations.

Instructions

Get the raw ADSO XML used for PUT updates. ALWAYS prefer outputPath — payloads are 15–80 KB. With outputPath, the full XML is written to disk (reuse as xmlPath in bw_adso_save_and_activate) and the MCP response is only a summary envelope. Without outputPath, format='summary' (default) returns a small overview; format='xml' returns the raw XML inline. Step 1 of read-modify-write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
formatNoOnly affects inline responses (no outputPath). summary (default) = overview; xml = raw XML.
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.
forceCacheUpdateNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.8/5.0
Behavior5/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 response envelope shape with and without outputPath, the disk-write behavior, the raw-XML plain-text file format, and the read-only role in a read-modify-write flow.

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?

Front-loaded with the core purpose, then prioritized usage guidance, then parameter behavior. Every sentence carries distinct operational information with no filler.

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?

Very complete for a read tool with no output schema: it covers output handling, formats, response envelope, and downstream integration. The only substantive gap is the undocumented forceCacheUpdate parameter.

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 description adds substantial meaning beyond the schema for outputPath and format, including file contents, reuse as xmlPath, and inline response behavior. However, forceCacheUpdate is not explained in either the schema or the description, preventing a perfect score.

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 a specific verb and resource: 'Get the raw ADSO XML used for PUT updates,' and anchors it as 'Step 1 of read-modify-write.' This clearly distinguishes it from other get_xml siblings by ADSO focus.

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?

Explicitly says 'ALWAYS prefer outputPath' for 15–80 KB payloads, explains when to use inline format instead, and contrasts with other *_get tools that write parsed JSON rather than raw XML. It also names the downstream reuse in bw_adso_save_and_activate.

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