get_flow
Retrieve detailed workflow information by its ID, including steps, descriptions, and input schemas, for executing sequences in VeyraX MCP server.
Instructions
"Use this tool to retrieve a specific workflow by its ID.
Workflow is sequence of steps that are executed in order to get some result. Flow comes with description, steps and input schema of all methods to call.
You can call this tool once you have a flowId which usually you can get from: user directly OR using get-tools method."
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| flowId | Yes | The ID of the workflow to retrieve. |
Implementation Reference
- src/tools/get-flow.ts:22-37 (handler)The execute method implements the core logic of the 'get_flow' tool, fetching workflow data by ID from the API and returning it as JSON.
async execute({ flowId }: z.infer<typeof this.schema>) { try { const { data } = await veyraxClient.get(`/flow/get-flow/${flowId}`); return { content: [ { type: "text" as const, text: JSON.stringify(data, null, 2), }, ], }; } catch (error) { throw error; } } - src/tools/get-flow.ts:18-20 (schema)Zod schema defining the input for the tool: a required flowId string.
schema = z.object({ flowId: z.string().describe("The ID of the workflow to retrieve."), }); - src/index.ts:15-15 (registration)Registers the GetFlowTool instance with the MCP server.
new GetFlowTool().register(server);