akadmin/headroom
1
0
Fork 0
mirror of https://github.com/headroomlabs-ai/headroom.git synced 2026-08-27 14:17:10 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add README for examples/mcp_demo

Browse source 
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>
This commit is contained in:
LeonSGP43 2026-08-15 12:32:21 +08:00
parent 322425c43b
commit 630d73fafb
1 changed files with 33 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
examples/mcp_demo/README.md Normal file
View file

@ -0,0 +1,33 @@
# MCP + Headroom Demo
Real-world demonstration of Headroom compression on MCP (Model Context Protocol) tool outputs.
## Quick Start
```bash
# Show compression on mock MCP tool outputs (no API key needed)
PYTHONPATH=. python -m examples.mcp_demo.show_compression
# Show the minimal BEFORE/AFTER code change for MCP integration
PYTHONPATH=. python -m examples.mcp_demo.show_before_after
# Run the full agent evaluation (requires OPENAI_API_KEY)
export OPENAI_API_KEY='your-key-here'
PYTHONPATH=. python -m examples.mcp_demo.run_agent_eval
```
## What each script does
| Script | Purpose |
|--------|---------|
| `show_compression.py` | Compresses mock MCP tool results (Slack search, database queries, GitHub issues, log analysis) via `compress_tool_result_with_metrics` and prints before/after sizes. |
| `show_before_after.py` | Prints the minimal code diff needed to add Headroom compression to MCP tool outputs in your host application. |
| `run_agent_eval.py` | Simulates an agent with multiple MCP tools and tests whether compression preserves the information needed to answer correctly. Deterministic test-data generators keep the eval reproducible. |
| `mock_mcp_servers.py` | Test-data generators simulating real MCP server outputs. |
## Key imports
```python
from headroom.integrations.mcp import compress_tool_result_with_metrics
from headroom.providers import OpenAIProvider
```