get_step_schema
Retrieve the complete schema of allowed fields for workflow steps to understand configurable parameters and ensure only valid data is persisted.
Instructions
Get the full schema of allowed fields on workflow steps (PipelineStep type). Returns field names, types, descriptions, grouped by category. Use this to understand what fields you can set on a step. Unknown fields are automatically stripped on save — only fields listed here are persisted.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/workflows.ts:452-468 (registration)Registration of the get_step_schema tool in the MCP server.
server.tool( 'get_step_schema', `Get the full schema of allowed fields on workflow steps (PipelineStep type). Returns field names, types, descriptions, grouped by category. Use this to understand what fields you can set on a step. Unknown fields are automatically stripped on save — only fields listed here are persisted.`, {}, async (_args, extra) => { const client = clientFactory(extra); const result = await client.getStepSchema(); return { content: [{ type: 'text' as const, text: JSON.stringify(result, null, 2), }], }; } ); - src/client.ts:246-248 (handler)The actual handler implementation in the AgentledClient class, which makes a request to the API.
async getStepSchema() { return this.request('/workflows/step-schema'); }