get_workflow_details
Retrieve workflow details and required input schema from the Opus automation platform to understand job requirements before execution.
Instructions
Get workflow details including jobPayloadSchema that defines required inputs for a workflow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflowId | Yes | The ID of the workflow to retrieve details for |
Implementation Reference
- src/index.ts:244-258 (handler)The handler function that executes the get_workflow_details tool by making an API call to retrieve workflow details using the provided workflowId and returns the JSON response.private async getWorkflowDetails(args: any) { const { workflowId } = args; const response = await this.axiosInstance.get( `/workflow/${workflowId}` ); return { content: [ { type: "text", text: JSON.stringify(response.data, null, 2), }, ], }; }
- src/index.ts:119-128 (schema)The input schema defining the required 'workflowId' parameter for the get_workflow_details tool.inputSchema: { type: "object", properties: { workflowId: { type: "string", description: "The ID of the workflow to retrieve details for", }, }, required: ["workflowId"], },
- src/index.ts:115-129 (registration)The tool registration object in the getTools() method that defines the name, description, and input schema for get_workflow_details.{ name: "get_workflow_details", description: "Get workflow details including jobPayloadSchema that defines required inputs for a workflow", inputSchema: { type: "object", properties: { workflowId: { type: "string", description: "The ID of the workflow to retrieve details for", }, }, required: ["workflowId"], }, },