Generate Readme

What it does

When your agent uses it

• Tasks that involve Technical documentation
• Tasks that involve Authentication

Example prompts

• “Use the generate-readme skill to generate or updates a README.md for an Agent 365 sample agent”
• “/generate-readme”

Requirements

• Python 3
• Node.js
• Compatibility (from SKILL.md): ["claude-code"]
• Pre-approved tools (allowed-tools): Read, Write, Edit, Grep, Glob, Bash, AskUserQuestion

Workflow steps

12 steps, taken from the step headings in SKILL.md.

1. 1Title + Description
2. 2What This Sample Demonstrates
3. 3Prerequisites
4. 4Authentication + Identity
5. 5Environment Configuration
6. 6Running the Agent Locally
7. 7Deploying the Agent
8. 8Observability
9. 9Support
10. 10Contributing
11. 11Additional Resources
12. 12Trademarks

What it can do on your machine

Read from SKILL.md and the folder at commit ecbf899. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves these tools, so the agent can use them without asking each time:

  • Read
  • Write
  • Edit
  • Grep
  • Glob
  • Bash
  • AskUserQuestion

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  Hosts in commands or code, which the agent is likely to contact:

  • learn.microsoft.com
  • opensource.microsoft.com
  • cla.opensource.microsoft.com
  • go.microsoft.com

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

• Compatibility

  ["claude-code"]

  From compatibility in the SKILL.md frontmatter.

Context cost

Generate Readme loads about 2.6k tokens when it runs. Until then it costs about 72 tokens; SKILL.md has 649 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~72

When it runs · the whole SKILL.md, loaded when a task matches

~2.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

• NoteMentions a .env fileSKILL.md:109

  figuration reference — either a table of .env variables or appsettings.json keys. Include "Set by" column (CLI or Manual

• NotePre-approves every shell command (allowed-tools: Bash)SKILL.md

  allowed-tools: Read, Write, Edit, Grep, Glob, Bash, AskUserQuestion

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from microsoft/Agent365-Samples at commit ecbf899, republished under its MIT licence (© microsoft). 649 words, ~2,631 tokens.

name

generate-readme

description

Generates or updates a README.md for an Agent 365 sample agent. Detects the agent type (interactive or autonomous), programming language (.NET, Node.js, Python), and authentication model, then produces a README following the standard template with all required sections.

allowed-tools

Read, Write, Edit, Grep, Glob, Bash, AskUserQuestion

compatibility

["claude-code"]

user-invocable

true

argument-hint

Optional: path to sample agent directory

model

sonnet

# <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/).

## What This Sample Demonstrates

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

## 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>

## Authentication + Identity

| Aspect | Model |
|--------|-------|
| **Authentication** | <one of: Agent user, On behalf of the user, App-based> |
| **Identity** | <one of: Agent user with own identity, Agent identity, Entra app service principal> |

<1–2 sentences explaining how auth works in this specific sample. Reference the relevant code file.>

## Environment Configuration

### Agent 365 Setup

<Steps to provision the agent using the A365 CLI. Include `a365 setup all`, admin consent, and manual configuration (e.g., Azure OpenAI keys).>

### Configuration

<Configuration reference — either a table of .env variables or appsettings.json keys. Include "Set by" column (CLI or Manual).>

## Running the Agent Locally

### Quick start (Azure OpenAI only)

<Minimal setup — just LLM credentials, no A365.>

### Local development (with A365 observability)

<Full setup with A365 credentials and observability export.>

## Deploying the Agent

<Production deployment instructions. Include MSI/FIC requirements, environment variables, and hosting provider guidance.>

## Observability

<Describe the tracing spans produced by the agent (e.g., InvokeAgentScope, InferenceScope, ExecuteToolScope). For agents with a custom token flow, describe the FMI chain briefly. Link to the observability guide.>

## Support

For issues, questions, or feedback:

- **Issues**: Please file issues in the [GitHub Issues](https://github.com/microsoft/Agent365-Samples/issues) section
- **Documentation**: See the [Microsoft Agent 365 Developer Documentation](https://learn.microsoft.com/en-us/microsoft-agent-365/developer/)
- **Security**: For security issues, please see [SECURITY.md](../../../../SECURITY.md)

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Additional Resources

- [Microsoft Agent 365 Developer Documentation](https://learn.microsoft.com/en-us/microsoft-agent-365/developer/)
- [Agent observability guide](https://learn.microsoft.com/en-us/microsoft-agent-365/developer/observability)
- <Language-specific SDK repository link>
- <Any other relevant links>

## Trademarks

*Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.*

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License — see the [LICENSE](../../../../LICENSE.md) file for details.

© microsoft, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/generate-readme of microsoft/Agent365-Samples.

Open the folder on GitHubat commit ecbf899