使用说明
Kokoro MCP Server 开发环境设置指南
在这个导游中Kokoro MCP Server 详细说明如何设置项目开发环境。
前提条件
Kokoro MCP Server 开发需要以下软件:
- Python 3.10 以上
- uv 包管理器
- Git
- Docker 打开Docker Compose
- Kokoro 语音合成引擎(在实际模式下使用时)
基本设置
1.克隆存储库
# リポジトリのクローン
git clone https://github.com/yourusername/Kokoro-MCP-Server.git
cd Kokoro-MCP-Server
2. uv安装并创建虚拟环境
# uvのインストール(macOS/Linux)
curl -sSf https://astral.sh/uv/install.sh | sh
# または(Windows)
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
# 仮想環境の作成
uv venv
# 仮想環境の有効化(Windows)
.venv\Scripts\activate
# 仮想環境の有効化(macOS/Linux)
source .venv/bin/activate
3.安装依赖包
# 依存パッケージのインストール
uv pip install -r requirements.txt
# 開発用パッケージのインストール
uv pip install -r requirements-dev.txt
4. PyOpenJTalk安装
PyOpenJTalk表示Windows中的安装可能需要附加设置:
# Linuxの場合
CMAKE_POLICY_VERSION_MINIMUM=3.5 uv pip install pyopenjtalk
# Windowsの場合
$env:CMAKE_POLICY_VERSION_MINIMUM = "3.5"; uv pip install pyopenjtalk
# インストールに問題がある場合は、ビルド済みホイールを試す
uv pip install https://github.com/r9y9/pyopenjtalk/releases/download/v0.3.0/pyopenjtalk-0.3.0-cp39-cp39-win_amd64.whl
MeCab打开fugashi设置
1. MeCab安装(Linux)
sudo apt-get update
sudo apt-get install -y mecab libmecab-dev mecab-ipadic-utf8
2. fugashi打开unidic-lite安装
uv pip install fugashi[unidic] unidic-lite ipadic
3. Windows特定设置
Windows那么MeCab的配置文件路径可能需要手动设置:
# mecab_windows_setup.pyを実行
python mecab_windows_setup.py
开発用设定
1.开发模式的有效化
在开发模式下,将启用调试日志并自动反映更改。
# 開発モードで実行
MOCK_TTS=true python src/main.py --dev
2.日志设置
通过调整日志级别,可以查看详细的调试信息。
# デバッグログを有効にして実行
python src/main.py --log-level debug
3.使用莫克模式
Kokoro在没有语音合成引擎的环境下也能开发,可以使用莫克模式:
# モックモードで実行
MOCK_TTS=true python src/main.py
测试环境
1.运行测试
项目包括自动测试套件。
2.测试客户端
Docker环境
1. Docker构建和运行容器
# イメージをビルド
make build
# コンテナを起動
make up
# ログを確認
make logs
# コンテナ内でシェルを実行
make shell
2.多体系结构构建
可以为多个体系结构(amd64,arm64)构建映像:
# Docker Hub ユーザー名を設定
export DOCKER_HUB_USERNAME="your-username"
# マルチアーキテクチャビルドを実行
./build-multi-arch.sh
3.部署到生产环境
要部署到生产环境:
- 配置文件准备:
# 設定ファイルをコピーして編集
cp claude_desktop_config.json.example claude_desktop_config.json
- 编辑配置文件:
- API 设置关键帧
- 设置卷路径
- 设置资源限制
- 执行部署:
# デプロイスクリプトを実行
./deploy.sh
4.开发模式下的Docker执行
# 開発モードでコンテナを起動(モックTTSを使用)
make dev
调试方法
1.启用调试日志
要查看详细的调试信息,请调整日志级别。
# デバッグログを有効にして実行
python src/main.py --log-level debug
2. Python Debugger使用
Python可以使用调试程序交互调试代码:
# コード内でデバッグポイントを設定
import pdb; pdb.set_trace()
3.记录请求/响应
MCP记录并确认请求和响应:
# リクエスト/レスポンスのロギングを有効化
python src/main.py --log-level debug --log-requests
代码质量工具
1. Black代码格式
# コードのフォーマット
black src/ tests/
2. isort使用组织导入
# インポートの整理
isort src/ tests/
3. flake8护发素
# コードのリント
flake8 src/ tests/
4. mypy类型检查
# 型チェック
mypy src/
常见问题及解决办法
1. MeCab关联错误
MeCab缺少支持的问题mecabrc如果无法访问文件,请尝试以下解决方案:
# MeCabの設定ファイルを探す
find / -name mecabrc 2>/dev/null
# 環境変数の設定
export MECABRC=/path/to/mecabrc
# または、シンボリックリンクの作成
sudo ln -sf /path/to/mecabrc /usr/local/etc/mecabrc
2. fugashi打开unidic关联错误
# まず、既存のパッケージをアンインストール
uv pip uninstall fugashi ipadic unidic-lite
# インストールし直す
uv pip install fugashi[unidic] unidic-lite ipadic
3. PyTorch关联错误
# PyTorchの再インストール
uv pip uninstall torch
uv pip install torch
MCP开发最佳实践
- 明确工具定义: MCP请明确定义工具的参数和返回值
- 错误处理:所有MCP请正确处理请求的错误
- 测试驱动开发:在添加新功能之前创建测试
- 文档:所有API请适当地将和工具文档化
获取帮助
如果在开发过程中遇到问题:
- GitHub Issues 报告错误
- 项目名称Wiki 中所述修改相应参数的值
- README.md 屋脊ARCHITECTURE.md 查看文档
环境变数
可以使用以下环境变量自定义服务器行为:
OPENAI_API_KEY: OpenAI API按键CLAUDE_API_KEY: Claude API按键LOG_LEVEL:日志级别(DEBUG,INFO,WARNING,ERROR)MOCK_TTS:启用莫克模式(真/假)PORT:服务器端口号(默认值:8080)
故障排除
1. Docker相关问题
-
构建映像失败:
# キャッシュを使用せずにビルド make build-no-cache -
如果容器未启动:
# ログを確認 docker logs kokoro-mcp-server
2. PyOpenJTalk相关问题
CMake的版本错误:
# 環境変数を設定してインストール
CMAKE_POLICY_VERSION_MINIMUM=3.5 uv pip install pyopenjtalk
现在Kokoro MCP Server 的开发环境。快乐的编码!
