Skip to main content
Glama

get_workflow_definition

Retrieve complete workflow definitions including tasks and configuration from the Conductor workflow engine by specifying name and optional version.

Instructions

Get the definition of a workflow by name and version. Returns the complete workflow definition including all tasks and configuration.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workflowNameYesName of the workflow
versionNoVersion of the workflow (optional, defaults to latest)

Implementation Reference

  • Handler for get_workflow_definition tool: extracts workflowName and optional version from arguments, constructs the appropriate Conductor API endpoint, fetches the workflow definition, and returns it as formatted JSON.
    case "get_workflow_definition": {
      const { workflowName, version } = args as any;
      const url = version
        ? `/metadata/workflow/${workflowName}/${version}`
        : `/metadata/workflow/${workflowName}`;
      
      const response = await conductorClient.get(url);
      
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response.data, null, 2),
          },
        ],
      };
    }
  • Tool metadata and input schema definition for get_workflow_definition, specifying required workflowName and optional version parameters.
      name: "get_workflow_definition",
      description:
        "Get the definition of a workflow by name and version. Returns the complete workflow definition including all tasks and configuration.",
      inputSchema: {
        type: "object",
        properties: {
          workflowName: {
            type: "string",
            description: "Name of the workflow",
          },
          version: {
            type: "number",
            description: "Version of the workflow (optional, defaults to latest)",
          },
        },
        required: ["workflowName"],
      },
    },
  • src/index.ts:598-602 (registration)
    Registration of all tools including get_workflow_definition via the list_tools handler that returns the complete tools array.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools,
      };
    });
Behavior2/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 states this is a read operation ('Get') and describes the return content, but does not disclose behavioral traits such as error handling (e.g., if workflow not found), permissions required, rate limits, or whether it's idempotent. For a read tool with zero annotation coverage, this is a significant gap in behavioral context.

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?

The description is two sentences, front-loaded with the core purpose and followed by return details. Every sentence earns its place with no wasted words, making it efficient and easy to parse.

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

Completeness3/5

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

Given the tool's moderate complexity (read operation with 2 parameters), no annotations, and no output schema, the description is partially complete. It covers the purpose and return content but lacks behavioral details like error handling or permissions. It is adequate as a minimum viable description but has clear gaps in context.

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 description coverage is 100%, so the schema already documents both parameters (workflowName and version) with descriptions. The description adds marginal value by implying the version parameter defaults to latest, but does not provide additional semantics beyond what the schema offers. Baseline 3 is appropriate when 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?

The description clearly states the specific action ('Get the definition'), resource ('workflow'), and scope ('by name and version'), distinguishing it from siblings like get_workflow_status or list_workflow_definitions. It explicitly mentions what is returned ('complete workflow definition including all tasks and configuration'), which adds clarity beyond just the name.

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?

The description implies usage for retrieving a specific workflow's definition by name and version, but does not explicitly state when to use this tool versus alternatives like list_workflow_definitions or get_task_definition. It provides some context but lacks clear exclusions or named alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/opensensor/conductor-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server