@polymorphism-tech/morph-spec 8.29.0 → 8.32.0

package/framework/standards/ai-agents/middleware-patterns.md

@@ -1,207 +1,207 @@
-# Middleware Patterns — Intercepting agent behavior
-
-> **Scope:** stacks=["dotnet"]
-> **Layer:** 1 (on-keyword)
-> **Keywords:** middleware, agent middleware, function calling middleware, retry, anti-hallucination, resilience, telemetry middleware, agent run middleware
-> **Read by Claude in:** implement (when wiring cross-cutting behavior into an agent)
-
-**Verified against:** MAF 1.0 GA. Last-verified: 2026-05-19.
-
----
-
-## Os 3 níveis de middleware
-
-| Tipo | Intercepts | Use Case |
-|------|-----------|----------|
-| **Agent Run** | Invocação completa do agent | Logging, auth, rate limiting |
-| **Function Calling** | Chamadas individuais de tools | Error handling, validação, auditoria |
-| **IChatClient** | Chamadas brutas ao LLM | Telemetry, caching, content filtering |
-
-Cada nível tem uma assinatura de delegate distinta. Os três podem coexistir no mesmo agent — cada um atua na sua camada sem interferir nos outros.
-
----
-
-## Registrando middleware
-
-O registration point é sempre `.AsBuilder().Use(...).Build()`. Encadeie múltiplos middlewares antes de chamar `Build()`.
-
-```csharp
-using Microsoft.Agents.AI;
-using Microsoft.Extensions.AI;
-
-// Obter o IChatClient via Model Registry — provider-agnostic
-IChatClient chatClient = _modelRegistry.GetChatClient("text-default");
-
-// IChatClient-level middleware (antes de criar o agent)
-IChatClient instrumentedClient = chatClient
-    .AsBuilder()
-        .Use(getResponseFunc: TelemetryMiddleware, getStreamingResponseFunc: null)
-    .Build();
-
-// Agent Run + Function Calling middleware
-AIAgent agent = instrumentedClient
-    .AsAIAgent(instructions: "You are a helpful assistant.")
-    .AsBuilder()
-        .Use(runFunc: LoggingMiddleware, runStreamingFunc: null)
-        .Use(ResilientToolMiddleware)   // function calling middleware
-    .Build();
-```
-
-> Se apenas middleware não-streaming for fornecido, chamadas streaming rodam em modo não-streaming.
-
----
-
-## Pattern: telemetria
-
-IChatClient-level middleware que mede latência e token usage de cada chamada bruta ao LLM.
-
-```csharp
-using System.Diagnostics;
-using Microsoft.Agents.AI;
-using Microsoft.Extensions.AI;
-
-async Task<ChatResponse> TelemetryMiddleware(
-    IEnumerable<ChatMessage> messages,
-    ChatOptions? options,
-    IChatClient innerChatClient,
-    CancellationToken cancellationToken)
-{
-    var sw = Stopwatch.StartNew();
-    var response = await innerChatClient.GetResponseAsync(messages, options, cancellationToken);
-    sw.Stop();
-    Console.WriteLine($"LLM call: {sw.ElapsedMilliseconds}ms, Tokens: {response.Usage?.TotalTokenCount}");
-    return response;
-}
-```
-
-Para o setup completo de OpenTelemetry (traces, métricas, Aspire Dashboard, `AgentOpenTelemetryConsts.DefaultSourceName`), consulte `ai-agents-production` §Observability. Não duplique aqui — este middleware é um ponto de entrada, não a solução completa.
-
----
-
-## Pattern: resilência (retry + rate-limit)
-
-Function Calling middleware que intercepta erros de tools antes que o agent receba exceções brutas. Devolver uma string descritiva ao agent permite que ele se autocorrija ou informe o usuário adequadamente.
-
-```csharp
-using Microsoft.Agents.AI;
-using Microsoft.Extensions.AI;
-
-async ValueTask<object?> ResilientToolMiddleware(
-    AIAgent agent,
-    FunctionInvocationContext context,
-    Func<FunctionInvocationContext, CancellationToken, ValueTask<object?>> next,
-    CancellationToken cancellationToken)
-{
-    try
-    {
-        return await next(context, cancellationToken);
-    }
-    catch (HttpRequestException ex) when (ex.StatusCode == System.Net.HttpStatusCode.TooManyRequests)
-    {
-        return "Service is temporarily busy. Please try again in a moment.";
-    }
-    catch (TimeoutException)
-    {
-        return $"Tool '{context.Function.Name}' timed out. Try a simpler query.";
-    }
-    catch (Exception ex)
-    {
-        return $"Error in {context.Function.Name}: {ex.Message}";
-    }
-}
-```
-
-Template completo com registro e stub de anti-hallucination: `templates/code/dotnet/ai-agents/ResilientToolMiddleware.cs.template`.
-
----
-
-## Pattern: anti-hallucination
-
-O LLM gera os argumentos de tool call baseado em linguagem natural — pode gerar formatos inválidos (datas malformadas, IDs fora de range, strings vazias). Validar **antes** de chamar `next()` permite que o agent se autocorrija na próxima iteração, sem precisar de retry externo.
-
-```csharp
-using Microsoft.Agents.AI;
-using Microsoft.Extensions.AI;
-
-async ValueTask<object?> AntiHallucinationMiddleware(
-    AIAgent agent,
-    FunctionInvocationContext context,
-    Func<FunctionInvocationContext, CancellationToken, ValueTask<object?>> next,
-    CancellationToken cancellationToken)
-{
-    // Validate 'date' argument before calling the tool
-    if (context.Arguments.TryGetValue("date", out var dateArg)
-        && !DateTime.TryParse(dateArg?.ToString(), out _))
-    {
-        return $"Invalid date format for '{context.Function.Name}'. Expected ISO 8601 (e.g. 2026-01-31).";
-    }
-
-    // Validate 'orderId' is a positive integer
-    if (context.Arguments.TryGetValue("orderId", out var idArg)
-        && (!int.TryParse(idArg?.ToString(), out var id) || id <= 0))
-    {
-        return $"Invalid orderId '{idArg}' for '{context.Function.Name}'. Must be a positive integer.";
-    }
-
-    return await next(context, cancellationToken);
-}
-```
-
-**Princípio:** devolva uma mensagem de erro descritiva — o LLM vai corrigir o argumento na próxima iteração. Não lance exceção; não chame `next()` com argumento inválido.
-
----
-
-## Decision tree
-
-```
-Precisa de middleware no agent?
-│
-├─ Logar / autorizar a invocação completa do agent?
-│   └─ Agent Run middleware
-│       .Use(runFunc: MyMiddleware, runStreamingFunc: null)
-│
-├─ Tratar falhas de tool / validar argumentos do LLM?
-│   └─ Function Calling middleware
-│       .Use(ResilientToolMiddleware)
-│
-└─ Medir / cachear / filtrar chamadas brutas ao LLM?
-    └─ IChatClient middleware
-        .Use(getResponseFunc: TelemetryMiddleware, getStreamingResponseFunc: null)
-        — aplicado no IChatClient.AsBuilder() ANTES de .AsAIAgent()
-```
-
----
-
-## Anti-patterns
-
-| Anti-pattern | Problema |
-|--------------|---------|
-| Swallow exception sem retornar contexto ao agent | O agent não consegue se autocorrigir — para silenciosamente |
-| Middleware que muta estado global | Viola isolation; causa race conditions em requests concorrentes |
-| Fornecer apenas middleware não-streaming | Chamadas streaming rodam em modo não-streaming silenciosamente — downgrade imperceptível |
-| Lógica de negócio em middleware | Middleware é cross-cutting only; lógica de domínio pertence ao tool ou ao handler |
-| Registrar middleware depois de `Build()` | `Build()` finaliza o pipeline — chamadas após não têm efeito |
-
----
-
-## Checklist (verifiable by morph-eval)
-
-- [ ] Middleware registrado via `.AsBuilder().Use(...).Build()` — nunca depois de `Build()`
-- [ ] IChatClient middleware aplicado no `chatClient.AsBuilder()` antes de `.AsAIAgent()`
-- [ ] Function Calling middleware retorna string descritiva em vez de lançar exceção
-- [ ] Anti-hallucination: argumentos validados antes de chamar `next()`
-- [ ] Nenhum middleware com `using Microsoft.SemanticKernel` — MAF 1.0 GA não usa SK
-- [ ] Streaming: se nenhum middleware streaming for fornecido, downgrade documentado como decisão consciente
-- [ ] Middleware que chama serviços externos tem timeout configurado
-
----
-
-## References
-
-- `ai-agents-setup` — pacotes, DI, quick start
-- `ai-agents-production` — panorama completo: observability, A2A, MCP, caching, middleware-as-one-of-many-concerns
-- `ai-agents-providers-model-registry` — `_modelRegistry.GetChatClient(alias)`, provider-agnostic pattern
-
----
-
-*MORPH-SPEC by Polymorphism Tech — ai-agents/middleware-patterns.md v1.0 (2026-05-19)*
+# Middleware Patterns — Intercepting agent behavior
+
+> **Scope:** stacks=["dotnet"]
+> **Layer:** 1 (on-keyword)
+> **Keywords:** middleware, agent middleware, function calling middleware, retry, anti-hallucination, resilience, telemetry middleware, agent run middleware
+> **Read by Claude in:** implement (when wiring cross-cutting behavior into an agent)
+
+**Verified against:** MAF 1.0 GA. Last-verified: 2026-05-19.
+
+---
+
+## Os 3 níveis de middleware
+
+| Tipo | Intercepts | Use Case |
+|------|-----------|----------|
+| **Agent Run** | Invocação completa do agent | Logging, auth, rate limiting |
+| **Function Calling** | Chamadas individuais de tools | Error handling, validação, auditoria |
+| **IChatClient** | Chamadas brutas ao LLM | Telemetry, caching, content filtering |
+
+Cada nível tem uma assinatura de delegate distinta. Os três podem coexistir no mesmo agent — cada um atua na sua camada sem interferir nos outros.
+
+---
+
+## Registrando middleware
+
+O registration point é sempre `.AsBuilder().Use(...).Build()`. Encadeie múltiplos middlewares antes de chamar `Build()`.
+
+```csharp
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+
+// Obter o IChatClient via Model Registry — provider-agnostic
+IChatClient chatClient = _modelRegistry.GetChatClient("text-default");
+
+// IChatClient-level middleware (antes de criar o agent)
+IChatClient instrumentedClient = chatClient
+    .AsBuilder()
+        .Use(getResponseFunc: TelemetryMiddleware, getStreamingResponseFunc: null)
+    .Build();
+
+// Agent Run + Function Calling middleware
+AIAgent agent = instrumentedClient
+    .AsAIAgent(instructions: "You are a helpful assistant.")
+    .AsBuilder()
+        .Use(runFunc: LoggingMiddleware, runStreamingFunc: null)
+        .Use(ResilientToolMiddleware)   // function calling middleware
+    .Build();
+```
+
+> Se apenas middleware não-streaming for fornecido, chamadas streaming rodam em modo não-streaming.
+
+---
+
+## Pattern: telemetria
+
+IChatClient-level middleware que mede latência e token usage de cada chamada bruta ao LLM.
+
+```csharp
+using System.Diagnostics;
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+
+async Task<ChatResponse> TelemetryMiddleware(
+    IEnumerable<ChatMessage> messages,
+    ChatOptions? options,
+    IChatClient innerChatClient,
+    CancellationToken cancellationToken)
+{
+    var sw = Stopwatch.StartNew();
+    var response = await innerChatClient.GetResponseAsync(messages, options, cancellationToken);
+    sw.Stop();
+    Console.WriteLine($"LLM call: {sw.ElapsedMilliseconds}ms, Tokens: {response.Usage?.TotalTokenCount}");
+    return response;
+}
+```
+
+Para o setup completo de OpenTelemetry (traces, métricas, Aspire Dashboard, `AgentOpenTelemetryConsts.DefaultSourceName`), consulte `ai-agents-production` §Observability. Não duplique aqui — este middleware é um ponto de entrada, não a solução completa.
+
+---
+
+## Pattern: resilência (retry + rate-limit)
+
+Function Calling middleware que intercepta erros de tools antes que o agent receba exceções brutas. Devolver uma string descritiva ao agent permite que ele se autocorrija ou informe o usuário adequadamente.
+
+```csharp
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+
+async ValueTask<object?> ResilientToolMiddleware(
+    AIAgent agent,
+    FunctionInvocationContext context,
+    Func<FunctionInvocationContext, CancellationToken, ValueTask<object?>> next,
+    CancellationToken cancellationToken)
+{
+    try
+    {
+        return await next(context, cancellationToken);
+    }
+    catch (HttpRequestException ex) when (ex.StatusCode == System.Net.HttpStatusCode.TooManyRequests)
+    {
+        return "Service is temporarily busy. Please try again in a moment.";
+    }
+    catch (TimeoutException)
+    {
+        return $"Tool '{context.Function.Name}' timed out. Try a simpler query.";
+    }
+    catch (Exception ex)
+    {
+        return $"Error in {context.Function.Name}: {ex.Message}";
+    }
+}
+```
+
+Template completo com registro e stub de anti-hallucination: `templates/code/dotnet/ai-agents/ResilientToolMiddleware.cs.template`.
+
+---
+
+## Pattern: anti-hallucination
+
+O LLM gera os argumentos de tool call baseado em linguagem natural — pode gerar formatos inválidos (datas malformadas, IDs fora de range, strings vazias). Validar **antes** de chamar `next()` permite que o agent se autocorrija na próxima iteração, sem precisar de retry externo.
+
+```csharp
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+
+async ValueTask<object?> AntiHallucinationMiddleware(
+    AIAgent agent,
+    FunctionInvocationContext context,
+    Func<FunctionInvocationContext, CancellationToken, ValueTask<object?>> next,
+    CancellationToken cancellationToken)
+{
+    // Validate 'date' argument before calling the tool
+    if (context.Arguments.TryGetValue("date", out var dateArg)
+        && !DateTime.TryParse(dateArg?.ToString(), out _))
+    {
+        return $"Invalid date format for '{context.Function.Name}'. Expected ISO 8601 (e.g. 2026-01-31).";
+    }
+
+    // Validate 'orderId' is a positive integer
+    if (context.Arguments.TryGetValue("orderId", out var idArg)
+        && (!int.TryParse(idArg?.ToString(), out var id) || id <= 0))
+    {
+        return $"Invalid orderId '{idArg}' for '{context.Function.Name}'. Must be a positive integer.";
+    }
+
+    return await next(context, cancellationToken);
+}
+```
+
+**Princípio:** devolva uma mensagem de erro descritiva — o LLM vai corrigir o argumento na próxima iteração. Não lance exceção; não chame `next()` com argumento inválido.
+
+---
+
+## Decision tree
+
+```
+Precisa de middleware no agent?
+│
+├─ Logar / autorizar a invocação completa do agent?
+│   └─ Agent Run middleware
+│       .Use(runFunc: MyMiddleware, runStreamingFunc: null)
+│
+├─ Tratar falhas de tool / validar argumentos do LLM?
+│   └─ Function Calling middleware
+│       .Use(ResilientToolMiddleware)
+│
+└─ Medir / cachear / filtrar chamadas brutas ao LLM?
+    └─ IChatClient middleware
+        .Use(getResponseFunc: TelemetryMiddleware, getStreamingResponseFunc: null)
+        — aplicado no IChatClient.AsBuilder() ANTES de .AsAIAgent()
+```
+
+---
+
+## Anti-patterns
+
+| Anti-pattern | Problema |
+|--------------|---------|
+| Swallow exception sem retornar contexto ao agent | O agent não consegue se autocorrigir — para silenciosamente |
+| Middleware que muta estado global | Viola isolation; causa race conditions em requests concorrentes |
+| Fornecer apenas middleware não-streaming | Chamadas streaming rodam em modo não-streaming silenciosamente — downgrade imperceptível |
+| Lógica de negócio em middleware | Middleware é cross-cutting only; lógica de domínio pertence ao tool ou ao handler |
+| Registrar middleware depois de `Build()` | `Build()` finaliza o pipeline — chamadas após não têm efeito |
+
+---
+
+## Checklist (verifiable by morph-eval)
+
+- [ ] Middleware registrado via `.AsBuilder().Use(...).Build()` — nunca depois de `Build()`
+- [ ] IChatClient middleware aplicado no `chatClient.AsBuilder()` antes de `.AsAIAgent()`
+- [ ] Function Calling middleware retorna string descritiva em vez de lançar exceção
+- [ ] Anti-hallucination: argumentos validados antes de chamar `next()`
+- [ ] Nenhum middleware com `using Microsoft.SemanticKernel` — MAF 1.0 GA não usa SK
+- [ ] Streaming: se nenhum middleware streaming for fornecido, downgrade documentado como decisão consciente
+- [ ] Middleware que chama serviços externos tem timeout configurado
+
+---
+
+## References
+
+- `ai-agents-setup` — pacotes, DI, quick start
+- `ai-agents-production` — panorama completo: observability, A2A, MCP, caching, middleware-as-one-of-many-concerns
+- `ai-agents-providers-model-registry` — `_modelRegistry.GetChatClient(alias)`, provider-agnostic pattern
+
+---
+
+*MORPH-SPEC by Polymorphism Tech — ai-agents/middleware-patterns.md v1.0 (2026-05-19)*