Open Context Protocol is live! 🚀 Read the launch post
workflowsStepFailed

workflowsStepFailed

Indicate that an app’s step in a workflow failed to execute.

Details

  • Method: GET
  • Path: /workflows.stepFailed
  • Operation ID: workflows_stepFailed

Parameters

{
  "token": {
    "description": "Authentication token. Requires scope: `workflow.steps:execute`",
    "required": true,
    "location": "header",
    "type": "string"
  },
  "workflow_step_execute_id": {
    "description": "Context identifier that maps to the correct workflow step execution.",
    "required": true,
    "location": "query",
    "type": "string"
  },
  "error": {
    "description": "A JSON-based object with a `message` property that should contain a human readable error message.",
    "required": true,
    "location": "query",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": true,
  "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
  "properties": {
    "ok": {
      "enum": [
        true
      ],
      "title": "default success response",
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "title": "Default success template",
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('slack')

# Call this tool
result = await agent.call_tool('workflowsStepFailed', {
    # Add required parameters here
})