docs: add README for examples/mcp_demo - #3045
Open
LeonSGP43 wants to merge 1 commit into
Open
Conversation
examples/langchain_demo has a README but examples/mcp_demo does not. Document the three runnable scripts (show_compression, show_before_after, run_agent_eval) and the mock MCP server generators, matching the langchain_demo README style. All commands and imports taken from the script docstrings and source. Signed-off-by: LeonSGP43 <LeonSGP43@users.noreply.github.com>
LeonSGP43
requested review from
DevanshiVyas,
JerrettDavis and
chopratejas
as code owners
August 15, 2026 04:32
Contributor
PR governanceThis PR follows the template and is marked ready for human review. |
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.
Description
Adds
examples/mcp_demo/README.mdin the same style asexamples/langchain_demo/README.md.examples/mcp_democontains three runnable demo scripts plus mock-server generators, but no README — the demo is undiscoverable and its entry points (module invocation withPYTHONPATH=., theOPENAI_API_KEYrequirement for the eval) are only documented inside script docstrings.Type of Change
Changes Made
examples/mcp_demo/README.md: overview, prerequisites, how to run each demo script (includingPYTHONPATH=.module invocation), mock-server generation, and expected output for the eval demo (OPENAI_API_KEYrequirement noted).Testing
pytest)ruff check .)mypy headroom)Test Output
Real Behavior Proof
main+ branchexamples/mcp_demo/; verified every referenced path exists__main__entry points and flags; env-var requirements match the codeOPENAI_API_KEY); mock-server demos were verified by reading the code pathsRuntime Rollout Safety
Review Readiness
Checklist
CHANGELOG.md— it is generated by release-please from my Conventional Commit PR titleAdditional Notes
Docs-only PR: pytest/ruff/mypy items intentionally unchecked (no Python code changed).