Skip to content

Add front-matter metadata to sample README files #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jim Daly (JimDaly) merged 6 commits into from
Oct 16, 2026
Merged

Add front-matter metadata to sample README files #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c6d3511
docs: update README files across samples with metadata for Agent 365
JimDaly Oct 15, 2026
0f173b6
Apply batched suggestions from code review
JimDaly Oct 16, 2026
f77d9c1
docs: update README files to refine descriptions and remove unnecessa…
JimDaly Oct 16, 2026
b2a8e8f
Merge branch 'jdaly/sample-browser-front-matter' of https://github.co…
JimDaly Oct 16, 2026
44f6bd5
docs: remove metadata comments from E2E test scripts README files
JimDaly Oct 16, 2026
8ead23a
docs: remove metadata comments from README files in quickstart samples
JimDaly Oct 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions agent-platforms/salesforce/apex-observability/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Salesforce Apex — Native Agent 365 Observability"
page_type: sample
languages:
- apex
products:
- agent-365
description: "Emit native Agent 365 telemetry from Salesforce Apex with correlated OTLP spans and agent-bound authentication."
---
-->

# Salesforce Apex — Native Agent 365 Observability

This sample shows how **Salesforce Apex** can participate in [Microsoft Agent 365](https://learn.microsoft.com/en-us/microsoft-agent-365/developer/)
Expand Down
12 changes: 12 additions & 0 deletions dotnet/agent-framework/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Agent Framework (Simple) Sample"
page_type: sample
languages:
- csharp
products:
- agent-365
description: "Build a .NET agent with Agent Framework and Agent 365 observability, notifications, and MCP tools."
---
-->

# Agent Framework (Simple) Sample

## Overview
Expand Down
12 changes: 12 additions & 0 deletions dotnet/autonomous/github-trending/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Autonomous Agent — .NET Sample"
page_type: sample
languages:
- csharp
products:
- agent-365
description: "Run an autonomous .NET agent that summarizes trending GitHub repositories with Azure OpenAI and Agent 365 tracing."
---
-->

# Autonomous Agent — .NET Sample

This sample demonstrates a **purely autonomous agent** built with the Microsoft Agent 365 SDK for .NET. Unlike the interactive agent samples, this agent has **no chat functionality** — it runs entirely as a background service using the `BackgroundService` pattern.
Expand Down
12 changes: 12 additions & 0 deletions dotnet/semantic-kernel/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Semantic Kernel Sample Agent - C#/.NET"
page_type: sample
languages:
- csharp
products:
- agent-365
description: "Build a Semantic Kernel agent in .NET with Agent 365 observability, notifications, and MCP tools."
---
-->

# Semantic Kernel Sample Agent - C#/.NET

This sample demonstrates how to build an agent using Semantic Kernel in C#/.NET with the Microsoft Agent 365 SDK. It covers:
Expand Down
12 changes: 12 additions & 0 deletions dotnet/w365-computer-use/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "W365 Computer Use Sample"
page_type: sample
languages:
- csharp
products:
- agent-365
description: "Control a Windows 365 Cloud PC from a .NET agent using the OpenAI Responses API and W365 Computer Use MCP tools."
---
-->

# W365 Computer Use Sample

## Overview
Expand Down
12 changes: 12 additions & 0 deletions nodejs/autonomous/github-trending/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Autonomous Agent — Node.js Sample"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Run an autonomous TypeScript agent that summarizes trending GitHub repositories with Azure OpenAI and Agent 365 tracing."
---
-->

# Autonomous Agent — Node.js Sample

This sample demonstrates a **purely autonomous agent** built with the Microsoft Agent 365 SDK for Node.js/TypeScript. It has **no chat functionality** — it runs entirely as a background service.
Expand Down
12 changes: 12 additions & 0 deletions nodejs/claude/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Claude Sample Agent - Node.js"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Build a Claude agent in TypeScript with Agent 365 observability, notifications, and MCP tools."
---
-->

# Claude Sample Agent - Node.js


Expand Down
12 changes: 12 additions & 0 deletions nodejs/copilot-studio/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Copilot Studio Sample Agent - Node.js"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Bridge a Microsoft Copilot Studio agent to Agent 365 with TypeScript hosting, notifications, and observability."
---
-->

# Copilot Studio Sample Agent - Node.js


Expand Down
13 changes: 12 additions & 1 deletion nodejs/devin/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
<!--
---
name: "Devin Sample Agent - Node.js"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Integrate Devin with a TypeScript agent using Agent 365 observability and notifications."
---
-->

# Devin Sample Agent - Node.js


This sample demonstrates how to build an agent using Devin in Node.js with the Microsoft Agent 365 SDK. It covers:

- **Observability**: End-to-end tracing, caching, and monitoring for agent applications
- **Notifications**: Services and models for managing user notifications
- **Tools**: Model Context Protocol tools for building advanced agent solutions
- **Hosting Patterns**: Hosting with Microsoft 365 Agents SDK

This sample uses the [Microsoft Agent 365 SDK for Node.js](https://github.com/microsoft/Agent365-nodejs).
Expand Down
2 changes: 1 addition & 1 deletion nodejs/langchain/quickstart-before/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This directory contains a quickstart agent implementation using Node.js and Lang
## Demonstrates

This sample is used to demonstrate how to build an agent using the Microsoft Agent 365 SDK with Node.js and LangChain. The sample includes basic LangChain Agent SDK usage hosted with Agents SDK that is testable on [agentsplayground](https://learn.microsoft.com/en-us/microsoft-365/agents-sdk/test-with-toolkit-project?tabs=windows).
Please refer to this [quickstart guide](https://review.learn.microsoft.com/en-us/microsoft-agent-365/developer/quickstart-nodejs-langchain?branch=main) on how to extend your agent using Microsoft Agent 365 SDK.
Please refer to this [quickstart guide](https://learn.microsoft.com/en-us/microsoft-agent-365/developer/quickstart-nodejs-langchain) on how to extend your agent using Microsoft Agent 365 SDK.

## Prerequisites

Expand Down
12 changes: 12 additions & 0 deletions nodejs/langchain/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "LangChain Sample Agent - Node.js"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Build a LangChain agent in TypeScript with Agent 365 observability, notifications, and MCP tools."
---
-->

# LangChain Sample Agent - Node.js


Expand Down
12 changes: 12 additions & 0 deletions nodejs/n8n/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "n8n Sample Agent"
page_type: sample
languages:
- javascript
Comment on lines +5 to +6

@DheerajPannala Krishnadheeraj (DheerajPannala) Oct 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: n8n sample is tagged javascript but contains no JavaScript

The new samples-browser metadata classifies this folder as a JavaScript sample. The directory has no JavaScript or TypeScript, and the README says there is no code to run. After onboarding, a JavaScript filter under Agent 365 will list a no-code n8n setup guide whose download is a Teams manifest and instructions.

Evidence

nodejs/n8n/sample-agent/README.md:6 is - javascript under languages:. The sample directory contains only README.md and manifest/ (manifest.json, agenticUserTemplateManifest.json, color.png, outline.png) — no .js, .ts, .mjs, or n8n workflow export. README.md:42 says "There is no external code to run or compile; simply use your n8n workflow". Sibling Node samples that actually ship TypeScript are tagged typescript. Failing scenario: the samples crawler indexes page_type: sample by language, so a customer filtering JavaScript + agent-365 opens "n8n Sample Agent" and does not get a JavaScript agent.

[claude-opus-5.5] nodejs/n8n/sample-agent/README.md:5-6 languages: / - javascript. At head, nodejs/n8n/** contains only README.md, manifest/manifest.json, manifest/agenticUserTemplateManifest.json, manifest/color.png and manifest/outline.png. There is no .js/.ts file, no package.json and not even an exported n8n workflow. README.md:42: "This sample is fully contained within n8n. The Microsoft Agent 365 node encapsulates all necessary code and integrations for the agent to function. There is no external code to run or compile". Scenario: a developer filters Agent 365 samples by JavaScript, opens 'n8n Sample Agent', clones it, and finds nothing in JavaScript to read or run.

Suggested fix: Do not set languages to javascript. If this entry stays in the browser, use a language value that matches files the folder actually ships, or omit it from the JavaScript catalog until it includes a script or workflow export.

products:
- agent-365
description: "Create an n8n workflow agent using its Microsoft Agent 365 node for observability, notifications, and MCP tools."
---
-->

# n8n Sample Agent

This sample demonstrates how to build an agent using n8n with its Microsoft Agent 365 node. The new Microsoft Agent 365 node in n8n has built-in:
Expand Down
12 changes: 12 additions & 0 deletions nodejs/openai/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "OpenAI Sample Agent - Node.js"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Build an OpenAI agent in TypeScript with Agent 365 observability, notifications, and MCP tools."
---
-->

# OpenAI Sample Agent - Node.js


Expand Down
12 changes: 12 additions & 0 deletions nodejs/perplexity/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Perplexity Sample Agent - Node.js"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Build a Perplexity agent in TypeScript with Agent 365 observability."
---
-->

# Perplexity Sample Agent - Node.js


Expand Down
12 changes: 12 additions & 0 deletions nodejs/vercel-sdk/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Vercel AI SDK Sample Agent - Node.js"
page_type: sample
languages:
- typescript
products:
- agent-365
description: "Build a Vercel AI SDK agent in TypeScript with Agent 365 observability, notifications, and MCP tools."
---
-->

# Vercel AI SDK Sample Agent - Node.js


Expand Down
12 changes: 12 additions & 0 deletions python/agent-framework/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Agent Framework Sample Agent - Python"
page_type: sample
languages:
- python
products:
- agent-365
description: "Build an Agent Framework agent in Python with Agent 365 observability, notifications, and MCP tools."
---
-->

# Agent Framework Sample Agent - Python

This sample demonstrates how to build an agent using Agent Framework in Python with the Microsoft Agent 365 SDK. It covers:
Expand Down
12 changes: 12 additions & 0 deletions python/autonomous/github-trending/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Autonomous Agent — Python Sample"
page_type: sample
languages:
- python
products:
- agent-365
description: "Run an autonomous Python agent that summarizes trending GitHub repositories with Azure OpenAI and Agent 365 tracing."
---
-->

# Autonomous Agent — Python Sample

This sample demonstrates a **purely autonomous agent** built with the Microsoft Agent 365 SDK for Python. It has **no chat functionality** — it runs entirely as a background service.
Expand Down
12 changes: 12 additions & 0 deletions python/claude/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Claude Sample Agent - Python"
page_type: sample
languages:
- python
products:
- agent-365
description: "Build a Python agent using the Claude Agent SDK with extended thinking, built-in tools, and Agent 365 integration."
---
-->

# Claude Sample Agent - Python

This directory contains a sample agent implementation using Python and Anthropic's Claude Agent SDK with extended thinking capabilities. This sample demonstrates how to build an agent using the Agent365 framework with Python and Claude Agent SDK. It covers:
Expand Down
12 changes: 12 additions & 0 deletions python/crewai/sample_agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "CrewAI Agent Sample - Python"
page_type: sample
languages:
- python
products:
- agent-365
description: "Build a CrewAI multi-agent weather and driving safety workflow with Agent 365 tracing, notifications, and MCP tools."
---
-->

# CrewAI Agent Sample - Python

This sample demonstrates how to build a multi-agent system using CrewAI while integrating with the Microsoft Agent 365 SDK. It mirrors the structure and hosting patterns of the AgentFramework/OpenAI Agent 365 samples, while preserving native CrewAI logic in `src/crew_agent/`.
Expand Down
12 changes: 12 additions & 0 deletions python/google-adk/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Google ADK Sample Agent - Python"
page_type: sample
languages:
- python
products:
- agent-365
description: "Build a Google ADK agent in Python with Agent 365 observability, notifications, and MCP tools."
---
-->

# Google ADK Sample Agent - Python

This sample demonstrates how to build an agent using Google ADK in Python with the Microsoft Agent 365 SDK. It covers:
Expand Down
12 changes: 12 additions & 0 deletions python/observability-with-azure-monitor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Observability — Agent 365 SDK alongside Azure Monitor"
page_type: sample
languages:
- python
products:
- agent-365
description: "Add Agent 365 observability to a Python app that already exports OpenTelemetry spans to Azure Monitor."
---
-->

# Observability — Agent 365 SDK alongside Azure Monitor

This sample shows how to add the [Microsoft Agent 365 Python SDK](https://github.com/microsoft/Agent365-python) to an app that **already** uses [Azure Monitor / Application Insights OpenTelemetry](https://learn.microsoft.com/azure/azure-monitor/app/opentelemetry-overview). After running this, both Azure Monitor and the Agent 365 backend receive your agent's spans.
Expand Down
12 changes: 12 additions & 0 deletions python/observability-with-langgraph/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Observability — Agent 365 SDK with LangGraph"
page_type: sample
languages:
- python
products:
- agent-365
description: "Add Agent 365 observability to a Python LangGraph agent while preserving its existing OpenTelemetry exporter."
---
-->

# Observability — Agent 365 SDK with LangGraph

This sample shows how to add the [Microsoft Agent 365 Python SDK](https://github.com/microsoft/Agent365-python) to a [LangGraph](https://langchain-ai.github.io/langgraph/) agent that **already** uses OpenTelemetry. After running this, both your existing exporter and the Agent 365 backend receive every span produced by the agent.
Expand Down
12 changes: 12 additions & 0 deletions python/observability-with-otlp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "Observability — Agent 365 SDK with manual OTel + manual instrumentation"
page_type: sample
languages:
- python
products:
- agent-365
description: "Instrument a Python agent manually with OpenTelemetry and Agent 365 tracing, with optional Agent 365 S2S export."
---
-->

# Observability — Agent 365 SDK with manual OTel + manual instrumentation

## Optional A365 S2S export
Expand Down
12 changes: 12 additions & 0 deletions python/openai/sample-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
---
name: "OpenAI Sample Agent - Python"
page_type: sample
languages:
- python
products:
- agent-365
description: "Build an OpenAI agent in Python with Agent 365 observability, notifications, and MCP tools."
---
-->

# OpenAI Sample Agent - Python

This sample demonstrates how to build an agent using OpenAI in Python with the Microsoft Agent 365 SDK. It covers:
Expand Down
Loading