MCP Walkthrough
Enables AI agents to present interactive code walkthroughs with voice narration, opening files, highlighting code, and showing inline explanations with synchronized text-to-speech.
README
MCP Walkthrough
An MCP server for interactive code walkthroughs with voice narration. Opens files, highlights code, shows inline explanations with a teleprompter-style bubble, and reads each step aloud using neural text-to-speech.
Works with any MCP client: Claude Code, Cursor, VS Code Copilot, Gemini CLI, Codex CLI, Windsurf.
Install
All clients at once
npx add-mcp walkthrough -- npx -y mcp-walkthrough
Auto-detects which AI coding tools you have and configures all of them.
Manual (any client)
Add to your MCP config (mcpServers key):
{
"walkthrough": {
"command": "npx",
"args": ["-y", "mcp-walkthrough"]
}
}
| Client | Config file |
|---|---|
| Claude Code | .mcp.json (project) or ~/.claude.json (global) |
| Cursor | .cursor/mcp.json |
| VS Code Copilot | .vscode/mcp.json |
| Windsurf | ~/.codeium/windsurf/mcp_config.json |
Skill (Claude Code)
npx skills add stefan-nitu/mcp-walkthrough
Installs the walkthrough skill so Claude auto-loads the tools when you ask it to explain code.
Note: Requires VS Code, VS Code Insiders, or Cursor. A companion VS Code extension is automatically installed on
npm install.
What It Does
Text in a terminal isn't enough when an AI explains a solution. MCP Walkthrough opens files in VS Code, highlights specific lines, shows rich markdown explanations, and narrates each step with a natural-sounding voice.
Teleprompter pattern: The explanation bubble builds up as the agent narrates — each highlight's text appends in bold, then unbolds when done. Selection moves through the code in sync with the voice.
Tools
| Tool | Description |
|---|---|
| walkthrough | One tool for all code presentation — 1 step with explanation shows an inline bubble; 1 step without explanation highlights only; N steps start a narrated tour; action: "clear" clears bubbles; action in next/prev/goto/stop/pause/resume navigates; empty args returns status |
| show_code | Open a file and highlight specific lines — ergonomic shortcut for the no-commentary case |
| settings | Global config: voice, bubbles, autoplay, autoplayDelay |
| walkthrough_voice_selection | Change narrator voice, audition voices, list available |
| get_selection | Read the currently highlighted code in VS Code |
walkthrough
The single entry point for code presentation — dispatches by arguments.
Multi-step narrated tour (N steps):
{
"steps": [
{
"file": "/absolute/path/to/file.ts",
"line": 33,
"endLine": 48,
"title": "Text Preparation",
"explanation": "Intro context — narrated first, shown in bubble.",
"highlights": [
{ "line": 35, "endLine": 36, "narration": "First section explained." },
{ "line": 37, "endLine": 40, "narration": "Second section explained." }
]
}
]
}
With highlights (teleprompter):
- Bubble shows
explanation— TTS narrates it - Each highlight appends
narrationin bold — selection moves to the highlight's lines - After the last highlight, all text unbolds and navigation controls appear
Without highlights: Simple bubble + full narration of the explanation.
Single-step explain (1 step with explanation): same shape, one entry in steps. Renders one bubble, no tour state.
Highlight only (1 step without explanation): { "steps": [{ "file": "…", "line": 10, "endLine": 15 }] }. Equivalent to show_code.
Navigation: { "action": "next" | "prev" | "goto" | "stop" | "pause" | "resume" }. For goto, pass step (0-based index).
Clear bubbles: { "action": "clear" }.
Status: call with no arguments — returns { active, currentStep, totalSteps, … }.
show_code
Ergonomic single-shot highlight — same as a walkthrough with one step that has no explanation.
{ "file": "/absolute/path/to/file.ts", "line": 10, "endLine": 15 }
settings
View or update global config. Changes persist across sessions.
{ "voice": true, "autoplay": false, "autoplayDelay": 2000 }
- voice — Toggle voice narration on/off
- showBubbles — Toggle explanation bubbles on/off
- autoplay — Auto-advance to next step after narration finishes
- autoplayDelay — Extra delay in ms after narration (additive)
Keyboard Shortcuts
Shown in the explanation bubble after the last highlight:
| Shortcut | Action |
|---|---|
Cmd+Shift+→ |
Next step |
Cmd+Shift+← |
Previous step |
Cmd+Shift+↓ |
Stop walkthrough |
How It Works
AI Agent → MCP Server (stdio) → Unix socket → VS Code Extension → Editor API + TTS
- Agent calls walkthrough tools via MCP
- MCP server sends steps to VS Code extension via workspace-specific Unix socket
- Extension shows bubbles, moves selection, narrates with TTS (Edge TTS + native fallback)
- Each VS Code window gets its own socket — multiple windows work independently
- Focus stays in your terminal — code appears in the editor beside it
TTS runs in the VS Code extension, not the MCP server. Keyboard shortcuts trigger the same narration path as MCP tool calls.
Development
bun install
bun test # 88 tests
bun run build # Builds MCP server + VS Code extension
bun run typecheck # Type checking
bun run lint # Biome linting
Local Testing
MCP server (npm global):
npm run build && npm install -g .
VS Code extension:
cd vscode-extension && node esbuild.js
npx @vscode/vsce package --allow-missing-repository -o walkthrough-bridge.vsix
code --install-extension walkthrough-bridge.vsix --force
Then restart VS Code (not just reload — extension code is cached).
License
MIT
Related Projects
- Model Context Protocol — MCP specification
- MCP TypeScript SDK — SDK used by this server
- add-mcp — Install MCP servers across all clients
推荐服务器
Baidu Map
百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。
Playwright MCP Server
一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。
Magic Component Platform (MCP)
一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。
Audiense Insights MCP Server
通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。
VeyraX
一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。
graphlit-mcp-server
模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。
Kagi MCP Server
一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。
e2b-mcp-server
使用 MCP 通过 e2b 运行代码。
Neon MCP Server
用于与 Neon 管理 API 和数据库交互的 MCP 服务器
Exa MCP Server
模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。