Skip to content

feat: add MCP friendly diagnostic APIs#3449

Draft
adarsh0728 wants to merge 2 commits into
numaflow-mcpfrom
api-first
Draft

feat: add MCP friendly diagnostic APIs#3449
adarsh0728 wants to merge 2 commits into
numaflow-mcpfrom
api-first

Conversation

@adarsh0728
Copy link
Copy Markdown
Member

Summary

This PR adds MCP/agent-friendly diagnostic APIs for Numaflow pipelines and mono-vertices. The goal is to expose small, typed, read-only responses that LLMs, automation tools can query directly.

Why

The existing server APIs are useful for the UI, but many of them return raw daemon/Kubernetes shapes, large resource objects, making automated debugging harder because agents first need to discover topology, correlate health/metrics/errors/events across several APIs, and normalize response formats themselves.

What Changed

Added single-purpose typed endpoints for diagnostics:

  • Vertex metrics and pending counts.
  • Pipeline buffer info and buffer pending counts.
  • Pipeline and mono-vertex data health.
  • Pipeline watermark lag.
  • Pipeline, vertex, and mono-vertex status summaries.
  • Vertex and mono-vertex logs.
  • Vertex and mono-vertex runtime errors.
  • Debug snapshots for both pipeline and monovertex
  • Events and Discovery APIs

Backward Compatibility

Existing UI/raw endpoints are preserved. New fields are additive.

Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
Signed-off-by: adarsh0728 <gooneriitk@gmail.com>
@adarsh0728 adarsh0728 marked this pull request as ready for review June 4, 2026 04:46
@adarsh0728 adarsh0728 marked this pull request as draft June 4, 2026 04:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant