Retrieve aggregated details for a specific vRealize Orchestrator workflow by ID, including associated information, to inspect configuration and dependencies.
Get aggregated information for a workflow Get a workflow with a specific ID GET /vro/aggregated-workflows/{id}
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | (path) |
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish read-only, idempotent, and non-destructive behavior. The description adds only a REST endpoint that is already repeated in the annotation title, and it does not explain what 'aggregated' includes or what the caller should expect beyond a normal workflow fetch.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short but slightly redundant: 'Get aggregated information for a workflow' and 'Get a workflow with a specific ID' largely restate each other, and the endpoint line duplicates the annotation title.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only retrieval tool with no output schema, the description should clarify what the aggregated response contains and why it differs from vro_workflow_get_one. It does not, leaving a meaningful gap for tool selection.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has full description coverage for the single id parameter, and the description confirms it is a workflow ID. It adds little beyond the schema, so the baseline of 3 is appropriate for a fully covered one-parameter tool.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
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 aggregated information for a workflow') and mentions retrieval by specific ID. However, 'aggregated' is never defined, and it does not distinguish this operation from close siblings such as vro_workflow_get_one, vro_workflow_get_aggregated, and vro_workflow_get_all.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
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. With siblings like vro_workflow_get_one and vro_workflow_get_aggregated present, the agent is left to infer which retrieval variant is appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.