A Model Context Protocol server providing VRM avatar functionality for LLMs
Project description
🤖 Agent VRM MCP サーバー
AgentVRM を介してVRMアバター機能を提供する Model Context Protocol サーバーです。このサーバーにより、Claude は AgentVRM エンジンが提供するVRMアバターを使用してテキストから音声を生成し、3Dアバターとして表現することができます。
🎥 デモ動画
https://github.com/user-attachments/assets/ea4b736d-a326-45b0-be88-b01fff6dc3f3
✨ 機能
- テキスト読み上げ: 指定したテキストを AgentVRM のVRMアバターで読み上げます。
- VRMアバター表示: 3DのVRMアバターがテキストを読み上げ、表情やアニメーションも表現します。
- 音声の自動再生: 生成した音声をその場で自動的に再生します。
- 音声ファイル保存: 生成した音声は
assetsフォルダに.wavファイルとして保存されます。
🚀 前提条件
- AgentVRM エンジンが動作していること(ローカルまたはリモートで)
- Python 3.10 以上
📦 インストール
uv の使用(推奨)
uv を使用する場合は特別なインストールは必要ありません。直接 uvx を使用して agent-vrm-mcp を実行します。
⚙️ 設定
AgentVRM エンジン
このサーバーは動作するために AgentVRM エンジンが必要です。エンジンの起動は手動で行う必要があります。
デフォルトでは http://localhost:3001/api/speak_text への接続を試みます。--api-url 引数で別の URL を指定することができます。
AgentVRM エンジンは 公式 AgentVRM リポジトリ からダウンロードしてインストールできます。
Claude Desktop 用の設定
Claude Desktop の設定に追加:
uvx を使用する場合
{
"mcpServers": {
"vrm": {
"command": "uvx",
"args": ["agent-vrm-mcp", "--api-url=http://localhost:3001/api/speak_text"]
}
}
}
🛠️ 利用可能なツール
speak_text- AgentVRM を使用してテキストを音声に変換し、VRMアバターで表現- 必須引数:
text(文字列): 音声に変換するテキスト
- オプション引数:
speaker_id(整数、デフォルト: 1): 使用する話者の IDspeed_scale(数値、デフォルト: 1.0): 再生速度の倍率auto_play(真偽値、デフォルト: True): 生成後に自動再生するか
- 必須引数:
🎵 特別な機能
- 生成後の音声は、プラットフォーム固有の方法で自動的に再生されます:
- Windows: デフォルトのシステムプレーヤーを使用
- macOS: 内蔵の
afplayユーティリティを使用 - Linux: まず
aplayを試し、失敗した場合はxdg-openにフォールバック
📁 プロジェクト構造
🧑💻 開発モードでのセットアップ・実行手順
開発者向けに、uv を用いた開発モードでのインストールおよびMCP Inspectorによる実行手順をまとめます。
# プロジェクトディレクトリで開発モードでインストール
cd C:\Prj\agent-vrm-mcp
uv sync
# 開発モードでパッケージをインストール
uv pip install -e .
# MCP Inspector で実行
npx @modelcontextprotocol/inspector python -m agent_vrm_mcp --api-url=http://localhost:3001/api/speak_text
uv syncで依存パッケージを同期します。uv pip install -e .で開発モード(編集可能インストール)を行います。- MCP Inspectorを使うことで、
agent_vrm_mcpサーバーをAPIエンドポイント指定で起動できます。
📄 ライセンス
agent-vrm-mcp は MIT ライセンスの下で提供されています。これは、MIT ライセンスの条件に従い、自由に使用、修正、配布することができることを意味します。
🔗 リンク
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agent_vrm_mcp-0.1.0.tar.gz.
File metadata
- Download URL: agent_vrm_mcp-0.1.0.tar.gz
- Upload date:
- Size: 36.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a9fa0afa0c9df134144d0796dfdbd1bc43b171322ba8ff9c32100244af9fade5
|
|
| MD5 |
3bb72aafc25c28013e639a2e9f5d2807
|
|
| BLAKE2b-256 |
bc5b18d8a371427ff4911d665454251ae404a6a62a5008eb9f5705bf784da2fd
|
Provenance
The following attestation bundles were made for agent_vrm_mcp-0.1.0.tar.gz:
Publisher:
deploy.yml on Sunwood-ai-labs/agent-vrm-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agent_vrm_mcp-0.1.0.tar.gz -
Subject digest:
a9fa0afa0c9df134144d0796dfdbd1bc43b171322ba8ff9c32100244af9fade5 - Sigstore transparency entry: 255554191
- Sigstore integration time:
-
Permalink:
Sunwood-ai-labs/agent-vrm-mcp@d6af8eaff4e8c199f6a6339100005042737e0bc8 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/Sunwood-ai-labs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy.yml@d6af8eaff4e8c199f6a6339100005042737e0bc8 -
Trigger Event:
push
-
Statement type:
File details
Details for the file agent_vrm_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: agent_vrm_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b3a11c988e17fd8f995eea73151b48ce428e4a8bb4f65c01c77080883565ce4
|
|
| MD5 |
c8d88090d1767a32625990591466620c
|
|
| BLAKE2b-256 |
b00f71d015327b2ecc6c2a7dd351929cfb909d0497effb7c52e35752f88ca79c
|
Provenance
The following attestation bundles were made for agent_vrm_mcp-0.1.0-py3-none-any.whl:
Publisher:
deploy.yml on Sunwood-ai-labs/agent-vrm-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agent_vrm_mcp-0.1.0-py3-none-any.whl -
Subject digest:
5b3a11c988e17fd8f995eea73151b48ce428e4a8bb4f65c01c77080883565ce4 - Sigstore transparency entry: 255554192
- Sigstore integration time:
-
Permalink:
Sunwood-ai-labs/agent-vrm-mcp@d6af8eaff4e8c199f6a6339100005042737e0bc8 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/Sunwood-ai-labs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy.yml@d6af8eaff4e8c199f6a6339100005042737e0bc8 -
Trigger Event:
push
-
Statement type: