Skip to main content
Glama
dnic-dev

bw-modeling-mcp

by dnic-dev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

bw_get_query

Reads a BW Query definition, including variables, filters, layout, measures, exceptions, and cell definitions. Falls back to inactive version if active not found.

Instructions

Read a BW Query definition — variables, filter, layout (rows/columns/free characteristics), calculated and restricted measures, exceptions, and cell definitions. Structure members are reported with their properties: input readiness and disaggregation (the planning settings), decimals, scaling, sign inversion, constant selection, the local calculation (results / single values as), exception aggregation, position, nested child members and the inverse formulas that make an input-ready formula writable. A member that shows a reusable CKF reports the CKF's own exception aggregation separately from the member's. Each variable lists where the query uses it — filter, default value, key date, structure member, formula, CKF/RKF, exception, condition, cell or text — or says that no use was found; the settings carry the key date (system date, a fixed date or a variable). Tries the active version first; falls back to the inactive version if not found. format="text" (default): compact human-readable output. format="raw": full parsed JSON.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNo"text" (default): structured human-readable output. "raw": full parsed JSON.
query_nameYesTechnical name of the query (e.g. "QUERY_NAME").

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations the description carries the full burden, and it does well: it discloses the active-then-inactive version fallback, the semantic distinction between a member's exception aggregation and a reusable CKF's own, and how variable usage is enumerated. It does not cover permissions/auth needs or error behavior when neither version exists, keeping it short of a 5.

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?

It is front-loaded with purpose and the format behavior, but the middle is one dense block listing dozens of member properties in a single run-on sentence. The content earns its place given there is no output schema, but the lack of structure makes it harder to scan.

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

Completeness5/5

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

No output schema exists, so the description must convey return content, and it does so comprehensively — member properties, planning settings, variable usage enumeration, and the key date settings. For a two-parameter read tool this is complete enough for an agent to call and interpret the result.

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 coverage is 100%, so both parameters are already documented. The description restates the format enum values ("text" compact vs "raw" full JSON) but adds no meaning beyond the schema, and query_name gets no elaboration. Baseline 3 is appropriate when the schema does the heavy lifting.

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 ("Read a BW Query definition") and then enumerates exactly what parts are returned — variables, filter, layout, measures, exceptions, cells. This is enough to distinguish it from siblings like bw_query_data (data retrieval) and bw_get_ckf (single object) without opening a schema.

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?

Usage is implied rather than stated: the agent infers this is for inspecting a query definition as opposed to reading its data. It does give useful operational guidance on the active/inactive version fallback and the format choice, but never names an alternative sibling or a when-not condition, so routing remains partly inferential.

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