generate-readme

A README.md document generator for Microsoft Agent 365 sample agents. It detects the sample’s language, agent style, and sign-in setup, then creates or updates the documentation using a fixed structure.

In plain words
What is it for?
Use it to document interactive agents that respond to messages or autonomous agents that run in the background, including their language, orchestrator, authentication, tools, services, and configuration.
Why use it?
It removes the need to write and reorganize each sample’s README by hand while keeping required sections consistent. Existing sample details can be retained during the update.

Skill for Claude CodeCodex

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 skills/microsoft/agent365-samples/generate-readme
Any agent
npx skills add microsoft/Agent365-Samples --skill generate-readme
Clone the repo
git clone --depth 1 https://github.com/microsoft/Agent365-Samples

Made for: Claude Code, Codex.

Per session 56 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,349 The whole file, excluding the scripts and references it only reads on demand.
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.00056 $0.02349
Opus 5 $0.00028 $0.01175
Sonnet 5 $0.00011 $0.00470
Haiku 4.5 $0.00006 $0.00235

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

Security

Grade A, and why

generate-readme 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 3d 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.

.claude/skills/generate-readme/SKILL.md · 229 lines

How it starts

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

Generate README

Generate or update a README.md for a sample agent in the Agent365-Samples repository.

Instructions

  1. Detect the agent — identify the programming language, orchestrator, and whether it is interactive (message-driven) or autonomous (background service).
  2. Detect authentication + identity model — determine which combination applies (see table below).
  3. Generate the README using the exact template structure defined in this skill.
  4. Adapt content from the existing README if one exists — preserve sample-specific details (tool names, service names, configuration keys) but restructure to match the template.

README Template

The README MUST contain the following sections in this exact order. Do not add, remove, or reorder sections unless noted.

1. Title + Description

# <Sample Title> — <Language> Sample

<1–3 sentence description of what the sample demonstrates. State whether it is interactive or autonomous, what SDK/orchestrator it uses, and what makes it a useful reference.>

For comprehensive documentation, visit the [Microsoft Agent 365 Developer Documentation](https://learn.microsoft.com/en-us/microsoft-agent-365/developer/).

2. What This Sample Demonstrates

A table of patterns demonstrated and their file locations:

## What This Sample Demonstrates

| Pattern | Where |
|---------|-------|
| <pattern description> | `<file path>` |

3. Prerequisites

## Prerequisites

- <Runtime/SDK version>
- [Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli)
- [Agent 365 CLI](https://learn.microsoft.com/en-us/microsoft-agent-365/developer/agent-365-cli) (install: `dotnet tool install --global Microsoft.Agents.A365.DevTools.Cli --prerelease`)
- An Azure OpenAI resource with a deployed model (e.g., `gpt-4o`)
- An Entra tenant with at minimum the **Agent ID Developer** role
- <Any additional prerequisites specific to the sample>

4. Authentication + Identity

Read the full file on GitHub · 229 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. 3d ago First seen · 229 lines · 56 tokens per session scan A 47b8784639ec

Subscribe to this mod's changes

generate-readme is a skill published in the GitHub repository microsoft/Agent365-Samples (106 stars, last pushed 1mo ago), licensed MIT. It adds 56 tokens to every session and 2,349 once invoked, about $0.0003 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 skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens