Skip to main content
Glama
RapidMiner / Altair AI Studio MCP

RapidMiner / Altair AI Studio MCP

rm_process_xml

Retrieves the current RapidMiner process definition as XML, enabling inspection, saving, or reuse of the complete workflow.

Instructions

Return the current process as RapidMiner process XML.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "rm_process_xml"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden; it does at least signal a non-mutating read via 'Return' and names the output format (RapidMiner process XML). It does not state whether the call fails when no process is open, whether the XML reflects unsaved in-editor state, or how large a payload to expect.

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?

A single front-loaded sentence with zero filler; the resource and its format are stated before any qualification. Nothing could be removed without losing information.

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?

For a zero-parameter getter with no annotations and no output schema, the definition says what is returned and in what format, which is the essential contract. The only gap is the lack of any note on preconditions or how the XML relates to the sibling setter, which keeps it from a 5.

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 input schema is an empty object with zero parameters and 100% coverage, so there is nothing for the description to clarify. Baseline 4 applies for a zero-parameter tool.

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 gives a specific verb ('Return') and a specific resource ('the current process as RapidMiner process XML'), so an agent can immediately tell this is a read-side getter for process serialization. It stops short of naming the obvious write counterpart (rm_process_set_xml) or distinguishing itself from rm_process_structure, which also exposes process content in a different form.

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 explicit when-to-use guidance, no stated prerequisites (e.g., that a process must be open or attached to), and no mention of alternatives such as rm_process_set_xml for restoring XML or rm_process_structure for a structural summary. The read-only intent is only implied by the verb 'Return'.

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