docs(samples): backfill READMEs for 11 framework samples on agents branch#161
Closed
mmercuri wants to merge 4 commits into
Closed
docs(samples): backfill READMEs for 11 framework samples on agents branch#161mmercuri wants to merge 4 commits into
mmercuri wants to merge 4 commits into
Conversation
…ent_framework, pydantic_ai
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Backfills
README.mdfor the 11 MINOR framework adapter samples onfeat/instrument-frameworks-agents(perA:/tmp/adapter-samples-audit.md):Every claim in every README is source-traced to the corresponding
samples/instrument/<adapter>/main.py. No aspirational text. AllREADMEs follow the structure of the CLEAN reference samples
(
samples/instrument/smolagents/README.mdon the smolagents-closurebranch,
samples/instrument/openai/README.mdon the llm-providersbranch,
samples/instrument/browser_use/README.mdon thebrowser-use-full branch).
Each README includes: title + 1-sentence summary, Prerequisites
(install extra + required/optional env vars), Run command (
uv run python -m),What this demonstrates (source-traced component table), Expected
output (every actual print path from
main.py, including theexit-code-2 short-circuits), and a Multi-tenancy note explaining the
current transitional state vis-a-vis PR #118.
Total addition: 826 LOC of doc — well under the 1500 LOC PR-size
guard, so this lands as a single PR.
Audit findings honored
main.pyand nopre-existing
README.mdonfeat/instrument-frameworks-agents(verified via
git ls-tree -r origin/feat/instrument-frameworks-agents -- samples/instrument/).pyproject.tomllines 40-51.ms-agent-frameworkextra resolving tosemantic-kerneliscalled out in the ms_agent_framework README (per the line-47
pyproject mapping).
embeddingandbenchmark-importempty extras are documentedhonestly —
embeddingnotes that vector store hooks come from theunderlying store,
benchmark-importnotes it ships no extraruntime deps.
bedrock_agentsandstrandsREADMEs document live-only behavior(no mock mode in
main.py) and the exit-code-2 short-circuit.benchmark_importREADME documents that it is a data importer(no
HttpEventSink, no runtime events) — consistent with theaudit row.
Multi-tenancy disclosure
Every README includes a "Multi-tenancy note" stating that the
adapter constructor does not yet accept
org_idand that productionmulti-tenant wiring lands with PR #118 (DRAFT). This is honest
disclosure of the transitional state, not a workaround.
Test plan
main.pypyproject.tomllines 40-51python -m samples.instrument.<adapter>.main) are canonical