article
README
🚀 AivisSpeech MCP 服务器
AivisSpeech MCP 服务器是用于语音合成的 Model Context Protocol (MCP) 服务器的实现。它与 AivisSpeech 引擎协同工作,提供语音合成接口。借助 MCP 协议,AI 助手等应用程序能够轻松使用 AivisSpeech 的语音合成功能。
🚀 快速开始
AivisSpeech MCP 服务器提供了一系列实用功能,让你能够轻松实现语音合成。以下是使用该服务器的基本步骤:
必要条件
- Node.js 18.x 以上
- npm 9.x 以上
- AivisSpeech 引擎(需另行安装)
安装
# 克隆仓库
git clone https://github.com/kentaro/aivis-speech-mcp.git
cd aivis-speech-mcp
# 安装依赖
npm install
# 构建项目
npm run build
# 环境变量设置
cp .env.sample .env
# 编辑 .env 文件,进行必要的配置
# Cursor MCP 设置
cp .cursor/mcp.json.sample .cursor/mcp.json
# 将 mcp.json 文件内的 "/path/to/aivis-speech-mcp/dist/index.js"
# 替换为实际的项目路径
# 示例: "C:/Users/username/path/to/aivis-speech-mcp/dist/index.js"
环境配置
在 .env 文件中进行以下配置:
# AivisSpeech API 配置
AIVIS_SPEECH_API_URL=http://localhost:10086 # 示例地址,需根据实际情况修改
AIVIS_SPEECH_API_KEY=your_api_key_here # 替换为实际的 API 密钥
# 其他配置(如有)
SAMPLE_TEXT=hello # 示例文本
基本使用步骤
- 安装依赖:运行
npm install安装所需模块。 - 环境配置:编辑
.env文件,填写正确的 API 地址和密钥。 - 构建项目:运行
npm run build进行构建。 - 启动服务:运行
npm start启动服务器。
示例命令
# 安装依赖
npm install
# 构建项目
npm run build
# 启动服务器
npm start
✨ 主要特性
- 符合 MCP 协议的 API 端点
- 高品质语音合成(通过 AivisSpeech 引擎)
- TypeScript 的类型安全设计
- 简单的设置和高扩展性架构
📚 详细文档
架构
- 前端:负责接收用户请求和展示结果。
- 后端:处理业务逻辑,与 AivisSpeech 引擎通信。
- 引擎:提供语音合成服务。
API 规格
请求格式
{
"text": "hello world",
"speaker_id": "1",
"format": "wav"
}
响应格式
{
"audio_url": "http://example.com/audio.wav",
"duration": 3.5
}
MCP 协议连携
通过 MCP 协议,实现与 AI 助手的无缝对接。具体步骤如下:
- 注册服务:在 MCP 中心注册语音合成服务。
- 配置参数:设置相关参数(如音调、速度等)。
- 处理请求:接收并处理来自 MCP 的合成请求。
故障排除
常见问题及解决方法
- 无法连接到 AivisSpeech 引擎:
- 检查
.env文件中的AIVIS_SPEECH_API_URL是否正确。 - 确保引擎已启动且网络畅通。
- 检查
- 语音未播放:
- 检查系统语音设置,确保正确的音频设备已选择。
- 确保生成的音频文件路径和权限正确。
- speaker_id 无效:
- 确认 AivisSpeech 引擎中存在该 speaker_id。
- 参考引擎文档获取可用的 speaker ID 列表。
📄 许可证
致谢
- AivisSpeech 引擎团队
- Model Context Protocol 开发者
扫码联系在线客服