tool-response-contract

What problem does it solve?

Defines and enforces standardized response shapes for tool functions, route handlers, SSE events, and MCP tools across the chatbot stack to ensure predictable, debuggable outputs.

Core Features & Use Cases

• Contract-first workflow for any change to tool outputs or API responses, with explicit downstream impact assessment.
• Safe-touch and avoid zones that document where changes must not silently break consumers or require sweeping frontend rewrites.
• Centralized response-type registry that codifies expected return shapes for tool functions, routes, SSE events, and MCP tools, enabling consistent parsing and error handling.
• Comprehensive SSE event catalog and frontend consumer mapping to guarantee forward and backward compatibility of streamed data.
• Clear monitoring guidelines for success, partial success, and failure paths to catch regressions early.
• Frontend and MCP integration hygiene that enforcement data contracts across all transport layers.

Quick Start

Define the response contract for a new tool and verify downstream consumers before deploying.