JinDaGe - voicevox-mcp MCP Details

article

README

🚀 voicevox-mcp

本项目是一个与VOICEVOX引擎协同工作的MCP（Model Context Protocol）服务器，可实现语音合成以及获取扬声器信息。它采用TypeScript编写，并运用了MCP SDK。

🚀 快速开始

环境准备

VOICEVOX引擎的启动（推荐使用Docker）

docker compose up -d

执行上述命令后，VOICEVOX引擎将在localhost:50021启动。

安装依赖包并构建项目

npm install
npm run build

配置Cursor

{
  "mcpServers": {
    "voicevox-mcp": {
      "command": "node",
      "args": ["${Path to Repository}/dist/index.js"],
      "env": {
        "SPEAKER_ID": 8,
        "SPEED_SCALE": 1.2,
        "VOICEVOX_API_URL": "http://localhost:50021" 
      }
    }
  }
}

可根据需要对VOICEVOX_API_URL进行设置。

使用说明

可通过MCP客户端的speakers工具获取扬声器列表。
利用speak工具将文本合成为语音并在本地播放（由于使用了afplay命令，推荐在Mac环境下使用）。

✨ 主要特性

获取VOICEVOX引擎的扬声器信息（/speakers）。
使用指定的扬声器将文本合成为语音并在本地播放（/speak），此功能仅支持Mac系统。

📦 安装指南

启动VOICEVOX引擎

docker compose up -d

安装依赖并构建

npm install
npm run build

💻 使用示例

基础用法

在.cursor/mcp.json中进行如下配置：

{
  "mcpServers": {
    "voicevox-mcp": {
      "command": "node",
      "args": ["${Path to Repository}/dist/index.js"],
      "env": {
        "SPEAKER_ID": 8,
        "SPEED_SCALE": 1.2,
        "VOICEVOX_API_URL": "http://localhost:50021" 
      }
    }
  }
}

高级用法

可根据实际需求调整.cursor/mcp.json中的配置参数，例如修改SPEAKER_ID来选择不同的扬声器，调整SPEED_SCALE来改变语音播放速度等。

📚 详细文档

主要依赖包

@modelcontextprotocol/sdk
zod
typescript

🔧 技术细节

本项目使用TypeScript实现了与VOICEVOX引擎的交互，借助MCP SDK提供了语音合成和扬声器信息获取的功能。通过配置.cursor/mcp.json文件，可灵活调整项目的运行参数。

📄 许可证

本项目采用MIT许可证。

⚠️ 重要提示

若VOICEVOX引擎未在localhost:50021运行，则无法使用语音合成功能。

在非Mac环境下，请适当修改afplay部分的代码。

voicevox-mcp