Skip to main content

Voice interaction capabilities for Model Context Protocol (MCP) servers

Project description

Voice Mode

Install via: uvx voice-mode | pip install voice-mode | getvoicemode.com

Natural voice conversations for AI assistants. Voice Mode brings human-like voice interactions to Claude, ChatGPT, and other LLMs through the Model Context Protocol (MCP).

๐Ÿ–ฅ๏ธ Compatibility

Runs on: Linux โ€ข macOS โ€ข Windows (WSL) | Python: 3.10+ | Tested: Ubuntu 24.04 LTS, Fedora 42

โœจ Features

  • ๐ŸŽ™๏ธ Voice conversations with Claude - ask questions and hear responses
  • ๐Ÿ”„ Multiple transports - local microphone or LiveKit room-based communication
  • ๐Ÿ—ฃ๏ธ OpenAI-compatible - works with any STT/TTS service (local or cloud)
  • โšก Real-time - low-latency voice interactions with automatic transport selection
  • ๐Ÿ”ง MCP Integration - seamless with Claude Desktop and other MCP clients

๐ŸŽฏ Simple Requirements

All you need to get started:

  1. ๐Ÿ”‘ OpenAI API Key (or compatible service) - for speech-to-text and text-to-speech
  2. ๐ŸŽค Computer with microphone and speakers OR โ˜๏ธ LiveKit server (LiveKit Cloud or self-hosted)

Quick Start

claude mcp add --scope user voice-mode uvx voice-mode
export OPENAI_API_KEY=your-openai-key
claude
> /converse

๐ŸŽฌ Demo

Watch Voice Mode in action:

Voice Mode Demo

Example Usage

Once configured, try these prompts with Claude:

  • "Let's have a voice conversation"
  • "Ask me about my day using voice"
  • "Tell me a joke" (Claude will speak and wait for your response)
  • "Say goodbye" (Claude will speak without waiting)

The new converse function makes voice interactions more natural - it automatically waits for your response by default.

Installation

Prerequisites

  • Python >= 3.10
  • OpenAI API Key (or compatible service)

Quick Install

# Using Claude Code (recommended)
claude mcp add --scope user voice-mode uvx voice-mode

# Using UV
uvx voice-mode

# Using pip
pip install voice-mode

Manual Configuration for Different Clients

Claude Code (CLI)
claude mcp add voice-mode -- uvx voice-mode

Or with environment variables:

claude mcp add voice-mode --env OPENAI_API_KEY=your-openai-key -- uvx voice-mode
Claude Desktop

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}
Cline

Add to your Cline MCP settings:

Windows:

{
  "mcpServers": {
    "voice-mode": {
      "command": "cmd",
      "args": ["/c", "uvx", "voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

macOS/Linux:

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}
Continue

Add to your .continue/config.json:

{
  "experimental": {
    "modelContextProtocolServers": [
      {
        "transport": {
          "type": "stdio",
          "command": "uvx",
          "args": ["voice-mode"],
          "env": {
            "OPENAI_API_KEY": "your-openai-key"
          }
        }
      }
    ]
  }
}
Cursor

Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}
VS Code

Add to your VS Code MCP config:

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}
Windsurf
{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}
Zed

Add to your Zed settings.json:

{
  "context_servers": {
    "voice-mode": {
      "command": {
        "path": "uvx",
        "args": ["voice-mode"],
        "env": {
          "OPENAI_API_KEY": "your-openai-key"
        }
      }
    }
  }
}
Roo Code

Add to your Roo Code MCP configuration:

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

Alternative Installation Options

Using Docker
docker run -it --rm \
  -e OPENAI_API_KEY=your-openai-key \
  --device /dev/snd \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  -e DISPLAY=$DISPLAY \
  ghcr.io/mbailey/voicemode:latest
Using pipx
pipx install voice-mode
From source
git clone https://github.com/mbailey/voicemode.git
cd voicemode
pip install -e .

Tools

Tool Description Key Parameters
converse Have a voice conversation - speak and optionally listen message, wait_for_response (default: true), listen_duration (default: 10s), transport (auto/local/livekit)
listen_for_speech Listen for speech and convert to text duration (default: 5s)
check_room_status Check LiveKit room status and participants None
check_audio_devices List available audio input/output devices None
start_kokoro Start the Kokoro TTS service models_dir (optional, defaults to ~/Models/kokoro)
stop_kokoro Stop the Kokoro TTS service None
kokoro_status Check the status of Kokoro TTS service None

Note: The converse tool is the primary interface for voice interactions, combining speaking and listening in a natural flow.

Configuration

๐Ÿ“– See docs/configuration.md for complete setup instructions for all MCP hosts

๐Ÿ“ Ready-to-use config files in config-examples/

Quick Setup

The only required configuration is your OpenAI API key:

export OPENAI_API_KEY="your-key"

Optional Settings

# Custom STT/TTS services (OpenAI-compatible)
export STT_BASE_URL="http://localhost:2022/v1"  # Local Whisper
export TTS_BASE_URL="http://localhost:8880/v1"  # Local TTS
export TTS_VOICE="alloy"                        # Voice selection

# LiveKit (for room-based communication)
# See docs/livekit/ for setup guide
export LIVEKIT_URL="wss://your-app.livekit.cloud"
export LIVEKIT_API_KEY="your-api-key"
export LIVEKIT_API_SECRET="your-api-secret"

# Debug mode
export VOICEMODE_DEBUG="true"

# Save all audio (TTS output and STT input)
export VOICEMODE_SAVE_AUDIO="true"

# Audio format configuration (default: opus)
export VOICEMODE_AUDIO_FORMAT="opus"        # Options: opus, mp3, wav, flac, aac
export VOICEMODE_TTS_AUDIO_FORMAT="opus"    # Override for TTS only
export VOICEMODE_STT_AUDIO_FORMAT="mp3"     # Override for STT upload

# Format-specific quality settings
export VOICEMODE_OPUS_BITRATE="32000"       # Opus bitrate (default: 32kbps)
export VOICEMODE_MP3_BITRATE="64k"          # MP3 bitrate (default: 64k)

Audio Format Configuration

Voice Mode uses Opus audio format by default for optimal performance:

  • Opus (default): Best for voice, 50-80% smaller files than MP3, low latency
  • MP3: Wide compatibility, use if Opus causes issues
  • WAV: Highest quality, largest files
  • FLAC: Lossless compression, good for archival
  • AAC: Good compression, Apple ecosystem

The audio format is automatically validated against provider capabilities and will fallback to a supported format if needed.

Local STT/TTS Services

For privacy-focused or offline usage, Voice Mode supports local speech services:

  • Whisper.cpp - Local speech-to-text with OpenAI-compatible API
  • Kokoro - Local text-to-speech with multiple voice options

These services provide the same API interface as OpenAI, allowing seamless switching between cloud and local processing.

OpenAI API Compatibility Benefits

By strictly adhering to OpenAI's API standard, Voice Mode enables powerful deployment flexibility:

  • ๐Ÿ”€ Transparent Routing: Users can implement their own API proxies or gateways outside of Voice Mode to route requests to different providers based on custom logic (cost, latency, availability, etc.)
  • ๐ŸŽฏ Model Selection: Deploy routing layers that select optimal models per request without modifying Voice Mode configuration
  • ๐Ÿ’ฐ Cost Optimization: Build intelligent routers that balance between expensive cloud APIs and free local models
  • ๐Ÿ”ง No Lock-in: Switch providers by simply changing the BASE_URL - no code changes required

Example: Simply set OPENAI_BASE_URL to point to your custom router:

export OPENAI_BASE_URL="https://router.example.com/v1"
export OPENAI_API_KEY="your-key"
# Voice Mode now uses your router for all OpenAI API calls

The OpenAI SDK handles this automatically - no Voice Mode configuration needed!

Architecture

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”     โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”     โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚   Claude/LLM        โ”‚     โ”‚  LiveKit Server  โ”‚     โ”‚  Voice Frontend     โ”‚
โ”‚   (MCP Client)      โ”‚โ—„โ”€โ”€โ”€โ”€โ–บโ”‚  (Optional)     โ”‚โ—„โ”€โ”€โ”€โ–บโ”‚  (Optional)         โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜     โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜     โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
         โ”‚                            โ”‚
         โ”‚                            โ”‚
         โ–ผ                            โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”     โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚  Voice MCP Server   โ”‚     โ”‚   Audio Services โ”‚
โ”‚  โ€ข converse         โ”‚     โ”‚  โ€ข OpenAI APIs   โ”‚
โ”‚  โ€ข listen_for_speechโ”‚โ—„โ”€โ”€โ”€โ–บโ”‚  โ€ข Local Whisper โ”‚
โ”‚  โ€ข check_room_statusโ”‚     โ”‚  โ€ข Local TTS     โ”‚
โ”‚  โ€ข check_audio_devices    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Troubleshooting

Common Issues

  • No microphone access: Check system permissions for terminal/application
  • UV not found: Install with curl -LsSf https://astral.sh/uv/install.sh | sh
  • OpenAI API error: Verify your OPENAI_API_KEY is set correctly
  • No audio output: Check system audio settings and available devices

Debug Mode

Enable detailed logging and audio file saving:

export VOICEMODE_DEBUG=true

Debug audio files are saved to: ~/voicemode_recordings/

Audio Saving

To save all audio files (both TTS output and STT input):

export VOICEMODE_SAVE_AUDIO=true

Audio files are saved to: ~/voicemode_audio/ with timestamps in the filename.

Links

Community

License

MIT - A Failmode Project

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

voice_mcp-2.2.0.tar.gz (65.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

voice_mcp-2.2.0-py3-none-any.whl (73.6 kB view details)

Uploaded Python 3

File details

Details for the file voice_mcp-2.2.0.tar.gz.

File metadata

  • Download URL: voice_mcp-2.2.0.tar.gz
  • Upload date:
  • Size: 65.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for voice_mcp-2.2.0.tar.gz
Algorithm Hash digest
SHA256 3d2f2877cef6a1dad221b6433c535ec83c05aafb160492595646b701510ca964
MD5 2e4bb1551faef56d2a70f8b3b48367f8
BLAKE2b-256 86f86b132b53455d632a85076ba316248842edcad148627ce1f600a541eefefc

See more details on using hashes here.

File details

Details for the file voice_mcp-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: voice_mcp-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 73.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for voice_mcp-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 179864080d40e6a89e3a5e2b56e96b345b89cfc26934ccd55f7457caf2d4d638
MD5 b510ee0d16b2246e1eec0e569967112a
BLAKE2b-256 dec7856a9ecc089f7315de7b98b387a55e6fbeb4e0367ddf892c01fc61b38e98

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page