MCP Novel Game Server

🚀 MCP 小說遊戲服務器

本項目是一個支持多分支故事情節（視覺小說）的遊戲服務器，可同時運行英文和日文版本，能幫助您更好地理解 MCP（模型上下文協議）資源。您可以輕鬆地運行、編輯並添加新的故事情節，服務器支持用 YAML 編寫的故事情節文件，可通過添加自己的故事進行擴展。

如何製作 Visual Novel 遊戲的 MCP 服務器

🚀 快速開始

安裝依賴

uv sync

運行服務器

{
    "novel-game-server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/username/Documents/projects/mcp-novel-game-server", ## 替換為您的項目根目錄
                "run",
                "src/server.py"
            ]
        }
}

玩遊戲或測試情節

• 將您的故事情節文件放在 src/stories/<your_story>/ 中
• 您可以通過服務器的界面或在客戶端中指定情節 ID 來選擇情節

添加新情節

• 在 src/stories/ 下創建新的目錄（例如 villainess_rose 或 villainess_rose_ja）
• 添加故事情節 YAML 文件（參見現有示例）
• 添加描述情節的 meta.yaml

文件結構示例

project-root/
├── src/
│   ├── server.py
│   └── stories/
│       ├── villainess_rose/
│       ├── villainess_rose_ja/
│       └── ...
├── mcp_example.json
├── pyproject.toml
└── README.md

✨ 主要特性

• 支持多分支故事情節（視覺小說），可同時運行英文和日文版本。
• 幫助用戶更好地理解 MCP（模型上下文協議）資源。
• 可輕鬆運行、編輯並添加新的故事情節。
• 支持用 YAML 編寫的故事情節文件，可通過添加自己的故事進行擴展。

📦 安裝指南

安裝依賴

uv sync

運行服務器

{
    "novel-game-server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/username/Documents/projects/mcp-novel-game-server", ## 替換為您的項目根目錄
                "run",
                "src/server.py"
            ]
        }
}

💻 使用示例

基礎用法

玩遊戲或測試情節

- 將您的故事情節文件放在 `src/stories/<your_story>/` 中
- 您可以通過服務器的界面或在客戶端中指定情節 ID 來選擇情節

添加新情節

- 在 `src/stories/` 下創建新的目錄（例如 `villainess_rose` 或 `villainess_rose_ja`）
- 添加故事情節 YAML 文件（參見現有示例）
- 添加描述情節的 `meta.yaml`

📚 詳細文檔

注意事項

⚠️ 重要提示

• 使用 uv 作為包管理器和運行工具。
• 情節可以用英文或日文編寫。
• 有關情節樹和詳細信息，請參閱 src/stories/README.md。

💡 使用建議

在 Cline 環境下，一切都可以直接使用。在其他環境（如 Claude Desktop 和 Cursor），請使用 server_tool.py 來正確啟動和管理服務器。