Agents-for-net serialization-extension.instructions.md

Development instructions for extending the Agent Framework’s JSON serialization system, which converts program data to and from JSON. They describe how types, converters, and generated setup code are registered.

In plain words
What is it for?
Use them when adding serialization converters, type resolvers, entity registrations, or compile-time initialization in the microsoft/Agents-for-net project.
Why use it?
They help contributors follow the project’s existing serialization design and avoid unsafe changes to shared settings or registration code.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/microsoft/agents-for-net/serialization-extension
Clone the repo
git clone --depth 1 https://github.com/microsoft/Agents-for-net

Made for: GitHub Copilot.

Per session 503 This file is loaded in full into every session.
When invoked 503 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00503 $0.00503
Opus 5 $0.00251 $0.00251
Sonnet 5 $0.00101 $0.00101
Haiku 4.5 $0.00050 $0.00050

Measured 2d ago against content hash cf74b5ef36ca, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Agents-for-net serialization-extension.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/serialization-extension.instructions.md · 32 lines

How it starts

The opening of the file, as written. The whole thing — 32 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Serialization Extension Context

When working on serialization infrastructure, read docs/serialization-extension-sequence-diagram.md for the full mermaid sequence diagrams covering compile-time generation, runtime initialization, and extension patterns.

Key Design Points

  • ProtocolJsonSerializer is a static class with SerializationOptions (System.Text.Json) and EntityTypes dictionary. All SDK serialization routes through it.
  • [SerializationInit] marks a class/struct whose public static void Init() method will be called when ProtocolJsonSerializer is first accessed (via its static constructor). Use it to register converters via ApplyExtensionConverters or resolvers via AddTypeInfoResolver.
  • [EntityName("name")] overrides the key used to register an Entity subclass in EntityTypes. Without it, the class name is used.
  • Source generators (SerializationInitSourceGenerator, EntityInitSourceGenerator) emit assembly-level attributes at compile time — no explicit [assembly: ...] lines are authored by developers.
  • Thread safety — All mutations to SerializationOptions use copy-on-write under _optionsLock. Never mutate the current SerializationOptions instance directly; always go through ApplyExtensionConverters, AddTypeInfoResolver, or ApplyExtensionOptions.
  • Late-loaded assemblies — Both init attributes hook AppDomain.AssemblyLoad to handle assemblies loaded after the static constructor runs.

Conventions

  • Extension libraries place their [SerializationInit] class in a Serialization/ subfolder (e.g., Microsoft.Agents.Extensions.MSTeams/Serialization/SerializationInit.cs).
  • The Init() method must be public static void Init() — the runtime invokes it by reflection.
  • Custom JsonConverter classes live under Serialization/Converters/.
  • Entity subclasses need only inherit from Entity; the EntityInitSourceGenerator handles registration automatically.
  • When replacing TypeInfoResolver, always include CoreJsonContext.Default in the chain via JsonTypeInfoResolver.Combine(...).
  • Use System.Text.Json exclusively — Newtonsoft.Json is not used in this SDK.

Read the full file on GitHub · 32 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 32 lines · 503 tokens per session scan A cf74b5ef36ca

Subscribe to this mod's changes

Agents-for-net serialization-extension.instructions.md is an instructions file published in the GitHub repository microsoft/Agents-for-net (177 stars, last pushed 4d ago), licensed MIT. It adds 503 tokens to every session, about $0.0025 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens