mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-16 05:10:42 -07:00
Mounts FastMCP at /mcp (Streamable HTTP) so Claude Code, Cursor, Windsurf, and the VS Code MCP extensions can call voicebox.speak, voicebox.transcribe, voicebox.list_captures, and voicebox.list_profiles against the running Voicebox server. Backend - new backend/mcp_server package (tools, middleware, profile resolve, pub/sub events); named mcp_server to avoid shadowing the installed mcp PyPI package FastMCP imports internally - app.py migrated from @app.on_event to lifespan= so FastMCP's session manager cohabits with Voicebox's startup/shutdown - new MCPClientBinding table + /mcp/bindings CRUD; ClientIdMiddleware reads X-Voicebox-Client-Id into a ContextVar and stamps last_seen_at - profile resolution precedence: explicit -> per-client binding -> capture_settings.default_playback_voice_id - POST /speak REST wrapper for non-MCP callers (shell, ACP, A2A) - GET /events/speak SSE broadcasts speak-start / speak-end so the pill surfaces agent-initiated speech - backend/mcp_shim proxy (plain httpx) for stdio-only MCP clients - PyInstaller spec updates + new --shim build target (~18 MB) Frontend - Settings -> MCP page with HTTP / stdio / claude-mcp-add copy snippets, default voice picker, per-client bindings table, connection status - useMCPBindings, useSpeakEvents hooks - CapturePill gains 'speaking' state; DictateWindow subscribes to SSE and emits dictate:show so the Rust side surfaces the pill window Native - tauri.conf.json externalBin now includes voicebox-mcp - show_dictate_window helper + dictate:show listener in main.rs - (also in this commit: InputMonitoringGate UX, hotkey_monitor tweaks, landing footer/navbar updates, new overview docs for captures / dictation / mcp-server / voice-personalities) Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
title, description
| title | description |
|---|---|
| Documentation README | Voicebox documentation development guide |
This directory contains the documentation for Voicebox, built with Fumadocs.
Development
Running Locally
From the docs/ directory:
bun install
bun run dev
The docs will be available at http://localhost:3000.
Structure
content/docs/overview/— user-facing guides (installation, quick start, feature walkthroughs)content/docs/developer/— architecture, backend internals, and contributor guidescontent/docs/api-reference/— auto-generated from the backend's OpenAPI schemacontent/docs/index.mdx— landing pagepublic/— static assets (images, screenshots, videos)
Writing Docs
- Use
.mdxfiles for all documentation pages - Navigation is generated from
content/docs/meta.jsonfiles - Fumadocs components available:
Callout,Cards/Card,Tabs/Tab,Steps/Step,Accordion/AccordionGroup,Files/Folder/File - API reference pages under
api-reference/are regenerated from the backend's OpenAPI schema — don't edit them by hand
Deployment
Docs are automatically deployed when changes land on main.