Skip to main content
Glama
aywengo

MCP Kafka Schema Reg

get_workflow_status

Retrieve the current status of active workflows in the MCP Kafka Schema Registry. Use the workflow ID to filter results for targeted tracking and management.

Instructions

Get the status of active workflows.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workflow_idNo

Implementation Reference

  • Handler function for the workflow status tool. Retrieves status of specific or all active workflows, including progress, responses, and completion status. This corresponds to the 'get_workflow_status' tool mentioned in tests, though registered under 'workflow_status' name.
    @self.mcp.tool(description="Get the status of active workflows")
    async def workflow_status(instance_id: Optional[str] = None) -> str:
        """Get workflow status."""
        if instance_id:
            # Get specific workflow status
            state = self.multi_step_manager.active_states.get(instance_id)
            if state:
                workflow_id = state.metadata.get("workflow_definition_id")
                workflow = get_workflow_by_id(workflow_id) if workflow_id else None
                return json.dumps(
                    {
                        "instance_id": instance_id,
                        "workflow_name": workflow.name if workflow else "Unknown",
                        "current_step": state.current_step_id,
                        "steps_completed": len(state.step_history) - 1,
                        "total_steps": len(workflow.steps) if workflow else 0,
                        "responses": state.get_all_responses(),
                        "created_at": state.created_at.isoformat(),
                        "updated_at": state.updated_at.isoformat(),
                    }
                )
            else:
                # Check completed workflows
                completed_state = self.multi_step_manager.completed_workflows.get(instance_id)
                if completed_state:
                    return json.dumps(
                        {
                            "instance_id": instance_id,
                            "status": "completed",
                            "workflow_name": completed_state.metadata.get("workflow_name"),
                            "steps_completed": len(completed_state.step_history),
                            "responses": completed_state.get_all_responses(),
                            "completed": True,
                        }
                    )
                else:
                    return json.dumps({"error": f"Workflow instance '{instance_id}' not found"})
        else:
            # Get all active workflows
            active = self.multi_step_manager.get_active_workflows()
            return json.dumps({"active_workflows": active, "total_active": len(active)})
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is a 'Get' operation which implies read-only, but doesn't specify what 'status' includes, whether it returns real-time or cached data, error conditions, or response format. For a tool with zero annotation coverage, this is insufficient 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 a single, efficient sentence that gets straight to the point with zero wasted words. It's appropriately sized for a simple query tool and front-loads the essential information.

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

Completeness2/5

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

Given the lack of annotations, 0% schema description coverage, and no output schema, the description is incomplete. It doesn't explain the parameter, return values, or behavioral characteristics needed for proper tool invocation. For a query tool in a complex workflow management system, this leaves significant gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 0% description coverage, so the parameter 'workflow_id' is completely undocumented in the schema. The description doesn't mention this parameter at all, failing to compensate for the schema gap. It doesn't explain whether the parameter is required, what happens when it's null, or how it affects the query.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'status of active workflows', making the purpose immediately understandable. It doesn't specifically differentiate from sibling tools like 'describe_workflow' or 'workflow_status', but it's unambiguous about what it does.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'describe_workflow', 'list_workflows', or 'workflow_status'. There's no mention of prerequisites, context, or exclusion criteria, leaving the agent to guess based on tool names alone.

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

Related 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/aywengo/kafka-schema-reg-mcp'

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