-
Notifications
You must be signed in to change notification settings - Fork 0
Tutorial: "Secure your first MCP tool in 5 minutes" #46
Copy link
Copy link
Open
Labels
blockedBlocked by external dependency or issueBlocked by external dependency or issuecomplexity:complexHigh effort, significant design neededHigh effort, significant design neededphase:docsDocumentationDocumentationphase:examplesExample scriptsExample scriptspriority:mediumImportant but not blockingImportant but not blockingsize:LLarge change, over 200 linesLarge change, over 200 linestype:docsDocumentationDocumentation
Metadata
Metadata
Assignees
Labels
blockedBlocked by external dependency or issueBlocked by external dependency or issuecomplexity:complexHigh effort, significant design neededHigh effort, significant design neededphase:docsDocumentationDocumentationphase:examplesExample scriptsExample scriptspriority:mediumImportant but not blockingImportant but not blockingsize:LLarge change, over 200 linesLarge change, over 200 linestype:docsDocumentationDocumentation
Milestone: v0.3.0 | Tier: Strategic | Effort: Medium
Problem
No tutorial content exists.
README.mdhas a ~10-line quickstart but doesn't walk through a real scenario. Users evaluating the library must reverse-engineer the examples and docstrings to understand:The existing examples (
basic_cli.py,billing_demo.py,http_driver_demo.py) are functional but not pedagogical.Proposed Change
1. Tutorial document (
docs/tutorial.md)"Secure your first MCP tool in 5 minutes" — step-by-step guide:
pip install agent-kernelEach step has copy-pasteable code with expected output shown.
2. Self-contained tutorial script (
examples/tutorial_mcp.py)InMemoryDriver(no external dependencies)python examples/tutorial_mcp.pywith zero setup3. Interactive Jupyter notebook (optional)
examples/tutorial.ipynb— same content as the script but interactive4. README quickstart refresh
Update README.md quickstart to reference the tutorial and provide the minimal "wow" moment in 5 lines.
Acceptance Criteria
docs/tutorial.mdwalks a new user from install to working invocation in <5 minutesexamples/tutorial_mcp.pyruns successfully with zero external dependenciesmake cior equivalent)Affected Files
docs/tutorial.md(new)examples/tutorial_mcp.py(new)examples/tutorial.ipynb(new, optional)README.md(quickstart refresh)Dependencies
InMemoryDriver