Skip to content

Add the Microsoft Agent Framework integration page (.NET) - #5714

Draft
DABH wants to merge 13 commits into
mainfrom
dabh/microsoft-agent-framework-dotnet-docs
Draft

DABH wants to merge 13 commits into
mainfrom
dabh/microsoft-agent-framework-dotnet-docs

Conversation

@DABH

@DABH DABH commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

What does this PR do?

This PR gives the .NET SDK its first Integrations section: docs/develop/dotnet/integrations/index.mdx, the sidebar category, a link from the .NET developer guide, and the guide for the Temporal .NET plugin for Microsoft Agent Framework at docs/develop/dotnet/integrations/microsoft-agent-framework.mdx. The plugin (temporalio/ai-integrations#523, approved and merging) ships as Temporalio.Extensions.MicrosoftAgentFramework on net8.0 with Temporalio 1.20.0 or later. The page mirrors the Python page (#5712) and states where .NET differs: the plugin owns the agent loop because Agent Framework's AIAgent.RunAsync resumes off the workflow scheduler, so agents are called through TemporalAgent. The integrations grid gains a .NET filter with the existing Dotnet icon.

Notes to reviewers

The 19 code blocks are snipsync markers from temporalio/samples-dotnet#250 and stay empty until that PR merges, which waits for the package on nuget.org; yarn snipsync then fills them, staging only this page. Lands after #5712, which touches the same integrations-data.json, and carries current main. Vale with the CI config, the snipsync-marker, orphan and index-slug checks, and tsc pass; the grid change is worth a look in the Vercel preview.

DABH added 4 commits November 13, 2026 02:08
The grid's SDK union and pills stop at Go, Java, Python, Ruby and
TypeScript, so a .NET integration page could not be listed or filtered.
Add ".NET" first in the pill order, the order ReleaseNoteHeader and the
SDK guides use, and map it to the dotnetBlock icon through a local
record: the shared SDK_BLOCK_NAMES is keyed by identifier (Dotnet) and
GuidesGrid and the AI Cookbook cards consume it by key.

COMPONENTS.md now lists the value and the .NET and Go usage pages, and
says the data lives in integrations-data.json rather than the .ts file.
The markdown-pipeline handler reads the JSON with no SDK list and needs
no change.
First Integrations section for the .NET SDK: an index that renders the
grid filtered to .NET, a sidebar category, a link from the guide index,
the grid entry, and the page for Temporalio.MicrosoftAgentFramework.

The page follows the Python page's spine: install, hello world, tools as
Activities, MCP, the hooks that run in the Workflow, approvals through a
Query and an Update, structured output, streaming through a Workflow
Stream, Continue-As-New with the serialized session, TracingInterceptor,
why TemporalAgent owns the loop, and the runtime limits. Sample code
comes from samples-dotnet src/MicrosoftAgentFramework through snipsync;
the 19 blocks stay empty until that samples PR merges.
Track the plugin's final README: an approval response is bound to the
request the session surfaced and an unknown or unanswered one fails the
run; a provider that awaits an Activity, a Timer or a Child Workflow
fails the run and a throwing provider fails the Workflow Task; a chat
client or MCP transport factory that throws is a non-retryable
configuration error.

Correct the Continue-As-New paragraph. An unanswered approval travels in
the serialized session, so the next run fails unless the request is
answered first or carried in the input. Continue-As-New bounds Event
History, not the per-call payload. Attribute ChatOptions to
Microsoft.Extensions.AI, name the two MCP defaults, the CancellationToken
rule, the held-call rejection and the stream Signal rate. Follow the
samples' first revision: the middleware-provider marker, the narrowed
worker regions, the key check and the ResponseId restart.
Attribute the approval contract to Microsoft.Extensions.AI and say the
sample's Decide handler, not its validator, checks the identifier. Track
the plugin at fd33d168: hosted MCP server headers set in the Workflow
fail the run and belong in HostedMcpServerHeaders on the Worker, the
same plugin instance registers its Activities once while two instances
fail the Worker, and one instance's MCP connections close with the last
Worker using it.

Name the starter's reject argument, ClientEnvConfig and the typed throw
in the hello world Worker region, count a Signal and its Workflow Task
per batch, say when a summarizing reducer fails, drop "compose in either
order" from the tracing text, and qualify the ResponseId restart for
agents with tools.
@vercel

vercel Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
temporal-documentation Ready Ready Preview Nov 17, 2026 6:53pm UTC

Request Review

@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Snipsync coverage

SDK code lines in docs/ that come from Snipsync: 61.3% → 61.3% (±0.0 pts), 25,062 of 40,909 lines.

Section Snipsync lines Inline lines Snipsync % Change
develop/dotnet 2,374 0 → 7 100.0% → 99.7% −0.3 pts
All sections

All languages: 52.7% (25,929 of 49,220 lines).

Section Snipsync lines Inline lines Snipsync %
design-patterns 26 7,808 0.3%
develop/python 5,146 535 90.6%
develop/java 4,639 49 99.0%
guides 34 4,496 0.8%
develop/go 4,285 80 98.2%
develop/typescript 3,702 314 92.2%
develop/dotnet 2,374 7 99.7%
develop/rust 1,571 0 100.0%
develop/php 1,394 0 100.0%
develop/ruby 1,232 0 100.0%
develop 484 606 44.4%
production-deployment 116 746 13.5%
encyclopedia 0 837 0.0%
develop/worker-performance 48 177 21.3%
cloud 0 127 0.0%
references 0 48 0.0%
best-practices 11 17 39.3%
Language Snipsync lines Inline lines Snipsync %
Python 5,289 6,617 44.4%
Go 4,425 3,181 58.2%
Java 4,724 2,593 64.6%
TypeScript 3,869 2,778 58.2%
C# 2,449 464 84.1%
Rust 1,609 31 98.1%
Ruby 1,303 159 89.1%
PHP 1,394 24 98.3%
Snipsync origin Lines
temporalio/documentation-sdk-code-examples 21,060
temporalio/samples-python 2,266
temporalio/samples-typescript 693
temporalio/features 464
temporalio/samples-go 384
temporalio/samples-java 184
temporalio/reference-app-orders-go 11

Compared with 57a7192. Counts non-blank lines in fenced code blocks tagged with an SDK language. Hand-written code isn't compiled anywhere; code Snipsync pulls from a sample repository is built in that repository's CI. See UTILITIES.md.

@github-actions

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

The plugin at 619eb420 now classifies provider errors the way the
Python plugin does (408, 409, 429 and 5xx retry, every other 4xx fails
once, x-should-retry and retry-after-ms honored) and names Activity
summaries after the model, tool or server alone; the retry bullet and
the hello world summary follow.

From the parity matrix: the ToolNamePrefix behavior and the idle timeout
bounds under MCP, the HostedMcpServerTool.Headers failure in the
boundary bullet with the credentials bullet keeping where the headers
go, and the publish-failure outcome under streaming. "Install the
package" stays a bold label: a heading would put the page at 15.
At 3f41346b a chat client or MCP transport factory that throws is
logged and retried under the Activity's policy, and only a null client
or transport fails once as a configuration error; the Worker step, the
MCP paragraph and the credentials bullet say so, and the hello world
prose explains why the sample checks the key before the Worker starts.

Also from that commit: Retry-After and retry-after-ms accept a fraction
and are capped at 60 seconds; MCP tool names follow Agent Framework's
rule, so docs and docs_ both give docs_read_file; an AdditionalProperties
entry named authorization, x-api-key or api-key fails the run before any
Activity; and the plugin never sends a conversation identifier or
previous_response_id, with stored output switched off in the Worker
factory through the OpenAI SDK's options.
At ac3f6981 an MCP result reaches the model the way McpClientTool
delivers it, so an isError result is the server's text with no failed
Activity; a call that fails on the transport drops the cached
connection; a rejected approval carries the framework's "Tool call
invocation rejected." text; a missing required tool argument fails
before any Activity; a function's AdditionalProperties cross with its
schema; and the MCP name rule is the Python framework's.

Also from that range: AllowBackgroundResponses, ContinuationToken and
ConversationId on ChatOptions fail the run; HostedMcpServerHeaderProviders
takes a callable for refreshed headers; a StreamingTopic with no hosted
stream fails the run; the status is read from any exception with an int
Status or StatusCode; providers run under the SDK's scheduler checks;
the package reference stops below 2.0 and the plugin checks the MAAI001
constructors at construction; and the Workflow failure type needs no
registration.
The SDK team's review renamed the package and root namespace to
Temporalio.Extensions.MicrosoftAgentFramework, the pattern of the SDK's
own extension libraries; the install command, the namespace sentence
and the Testing namespace follow. Class, Activity and error type names
are unchanged, and the grid entry names no package.

The package now targets net8.0, so it runs on .NET 8, 9 and 10, and
its Temporalio floor is 1.20.0; the prerequisites and the versions
bullet say so. The snippet markers come from the samples and stay.
The install paragraph was left with a two-word line after the package
rename; fill it at 120 columns as prettier's prose wrap does.

The streaming bullet said batches are bounded. The WorkflowStreams
publisher's batch size wakes a flusher that takes the whole buffer, so
say the stream is flushed at 256 updates and republished on retry.
DABH added 2 commits November 15, 2026 03:05
At 4ad54eba a tool result the Workflow serialized from an AIContent
carries the MicrosoftAgentFramework.SerializedContent note in its
AdditionalProperties, and only those results are rebuilt on the Worker,
so a plain JSON result with a $type key reaches the model unchanged. A
token passed to RunAsync that is cancelled while a tool runs cancels its
Activity, and the cancellation surfaces to the caller; a token parameter
that is not trailing and optional is rejected because a token cannot
cross the Activity boundary.

The rest of the page already matches the README at that commit: the
package name, net8.0 on .NET 8 or later, Temporalio 1.20.0 and the
install line.
The samples now parse their arguments with System.CommandLine: rejection is the --reject option, end-chat signals before it reads the transcript, and the approval starter answers every round.
Temporalio.Extensions.MicrosoftAgentFramework 0.0.1 is a stable version on nuget.org, so the flag is not needed.

This branch was successfully deployed

1 active deployment
Preview — 513b7e07 Deployed Nov 17, 2026 by vercel[bot]
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