Repository navigation
Add front-matter metadata to sample README files - #345
Jim Daly (JimDaly) merged 6 commits into
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
HTML comment wrappers prevent the metadata blocks from being leading YAML front matter for sample discovery.
1 open finding
What changed in this PR
Adds README metadata intended to make Agent 365 samples discoverable in the Microsoft Samples browser.
Changes:
- Adds names, descriptions, language tags, product tags, and sample classification to 28 READMEs.
- Covers agent samples, observability examples, Salesforce references, and E2E tooling; no runtime code changes.
| File | Description |
|---|---|
| tests/e2e/README.md | Adds integration-test metadata. |
| scripts/e2e/README.md | Adds test-script metadata. |
| python/openai/sample-agent/README.md | Adds Python OpenAI metadata. |
| python/observability-with-otlp/README.md | Adds manual instrumentation metadata. |
| python/observability-with-langgraph/README.md | Adds LangGraph observability metadata. |
| python/observability-with-azure-monitor/README.md | Adds Azure Monitor metadata. |
| python/google-adk/sample-agent/README.md | Adds Google ADK metadata. |
| python/crewai/sample_agent/README.md | Adds CrewAI workflow metadata. |
| python/claude/sample-agent/README.md | Adds Python Claude metadata. |
| python/autonomous/github-trending/README.md | Adds autonomous Python metadata. |
| python/agent-framework/sample-agent/README.md | Adds Python Agent Framework metadata. |
| nodejs/vercel-sdk/sample-agent/README.md | Adds Vercel AI SDK metadata. |
| nodejs/perplexity/sample-agent/README.md | Adds Perplexity metadata. |
| nodejs/openai/sample-agent/README.md | Adds TypeScript OpenAI metadata. |
| nodejs/n8n/sample-agent/README.md | Adds n8n workflow metadata. |
| nodejs/langchain/sample-agent/README.md | Adds LangChain metadata. |
| nodejs/langchain/quickstart-before/README.md | Adds LangChain quickstart metadata. |
| nodejs/devin/sample-agent/README.md | Adds Devin metadata. |
| nodejs/copilot-studio/sample-agent/README.md | Adds Copilot Studio metadata. |
| nodejs/claude/sample-agent/README.md | Adds TypeScript Claude metadata. |
| nodejs/claude/quickstart-before/README.md | Adds Claude quickstart metadata. |
| nodejs/autonomous/github-trending/README.md | Adds autonomous TypeScript metadata. |
| dotnet/w365-computer-use/sample-agent/README.md | Adds Windows 365 metadata. |
| dotnet/semantic-kernel/sample-agent/README.md | Adds Semantic Kernel metadata. |
| dotnet/autonomous/github-trending/sample-agent/README.md | Adds autonomous .NET metadata. |
| dotnet/agent-framework/sample-agent/README.md | Adds .NET Agent Framework metadata. |
| agent-platforms/salesforce/apex-observability/README.md | Adds Apex observability metadata. |
| agent-platforms/salesforce/apex-observability/agent/README.md | Adds Agentforce reference metadata. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Krishnadheeraj (DheerajPannala)
left a comment
There was a problem hiding this comment.
This is a focused, consistent metadata update with concise descriptions that reflect the existing documentation. Keeping the change limited to README metadata preserves the existing sample implementations.
Six minor comments inline.
Co-authored-by: Krishnadheeraj <hello@kdheeraj.me>
0f173b6
…m/JimDaly/Agent365-Samples into jdaly/sample-browser-front-matter
Krishnadheeraj (DheerajPannala)
left a comment
There was a problem hiding this comment.
Keeping this focused on README metadata is a straightforward, maintainable approach to Samples browser onboarding. The consistent structure avoids unnecessary changes to the sample implementations.
One minor comment inline.
Since my last review:
- Still open: Devin and Vercel descriptions advertise MCP tools the code never registers (
nodejs/devin/sample-agent/README.md). Partially fixed: nodejs/devin/sample-agent/README.md:9 now advertises only observability and notifications, and its Tools bullet was removed. However, nodejs/vercel-sdk/sample-agent/README.md:9 still
| languages: | ||
| - javascript |
There was a problem hiding this comment.
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.

This metadata will enable these samples to appear in the Microsoft Samples browser