Skip to main content
Glama
tigeilen

pa-code-mcp-server

by tigeilen

tm1_get_cube_rules

Retrieve the calculation rules text for a specified cube in IBM Planning Analytics/TM1 models to inspect or debug rule logic.

Instructions

Rules text of a cube.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cubeNameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.3/5.0
Behavior1/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 for behavioral disclosure. However, 'Rules text of a cube' is only a noun phrase and does not state that this is a read-only retrieval, what it returns, or any failure or edge-case behavior. It does not contradict annotations, but it discloses no behavioral traits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely short, which is concise, but it is under-specified rather than efficiently structured. It lacks a complete sentence that states the action and connects the parameter to the operation, so the brevity does not earn its place.

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

Completeness2/5

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

The tool is simple, with one parameter and no output schema, so the missing context is not catastrophic. However, with no annotations, no usage guidance, and no explicit behavioral or return-value description, the agent is left to infer the operation and outcome. This is below the minimum needed for confident independent invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has one required parameter, cubeName, with 0% schema description coverage. The description's 'of a cube' hints that cubeName identifies the cube whose rules are retrieved, but it does not explain the parameter's role or any restrictions beyond the name itself. This is minimal compensation for the missing schema descriptions.

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 identifies the resource precisely as 'Rules text of a cube', and the tool name supplies the 'get' action. This distinguishes it from siblings like tm1_get_cube_dimensions and tm1_get_process_code, but the description itself lacks an explicit verb, so it does not fully state the action on its own.

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?

There is no guidance on when to use this tool versus alternatives, no mention of prerequisites, and no indication of situations where another sibling like tm1_execute_mdx or tm1_get_cube_grid would be more appropriate. The agent must infer usage purely from the name and resource phrase.

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